Feature/10 fix readme #11
Conversation
README.md
Outdated
|
|
||
| const path = path.resolve(__dirname, 'tests/configs/env'); | ||
| require('./../index.js'); // replace with require('nconfetti'); |
There was a problem hiding this comment.
Ich würde die README immer aus der Perspektive des Nutzers schreiben - also den Kommentar entfernen und direkt require('nconfetti');.
README.md
Outdated
| - node samples/simple.js | ||
| - have fun | ||
|
|
||
| ## Description | ||
|
|
||
| After require `nconfetti` the backend will be added as storage backend |
There was a problem hiding this comment.
Finde ich schlecht verständlich - besser: After requiring nconfetti the its storage will automagically be registered to nconf.
README.md
Outdated
| - node samples/simple.js | ||
| - have fun | ||
|
|
||
| ## Description | ||
|
|
||
| After require `nconfetti` the backend will be added as storage backend | ||
| for `nconf`. Then it needs to be configired with `path`and `env`. |
There was a problem hiding this comment.
Das initiale Beispiel erklärt nicht ausreichend wie path und env zu verwenden sind.
Hierzu würde es Sinn machen mehrere, saubere Beispiele für verschiedene Szenarien aufzunehmen.
Beispiele sind immer greifbarer als Text - auch zu den verschiedenen Options würde ich jeweils Beispiele aufnehmen.
There was a problem hiding this comment.
Ok, hier erstelle ich ein Issue. Ok?
There was a problem hiding this comment.
Ich würde das aber auch nicht als sample in Ordnern verstecken, sondern direkt in die README schreiben. Ich bin immer dankbar wenn ich fremde READMEs lese und dort alles finde, anstatt mich erst durch das gesamte Repo zu arbeiten und mir dort Beispiele zu suchen.
There was a problem hiding this comment.
habe ich verstanden ;-)
README.md
Outdated
| - runit with | ||
| - npm install | ||
| - node samples/simple.js | ||
| - have fun |
There was a problem hiding this comment.
Vorschlag:
1. navigate to sample/simple
2. run it with
`npm install`
`node samples/simple.js`
3. have funso sähe das aus:
-
navigate to sample/simple
-
run it with
npm install
node samples/simple.js -
have fun
Fragen
Geht das wirklich so?
Wo wird npm install ausgeführt?
README.md
Outdated
| After require `nconfetti` the backend will be added as storage backend | ||
| for `nconf`. Then it needs to be configired with `path`and `env`. | ||
| After requiring `nconfetti` the its storage will automagically be registered to `nconf`. | ||
| Then it needs to be configured with `path`and `env`. |
There was a problem hiding this comment.
Kleiner Typo ist drin, so ist das korrekt:
After requiring
nconfettiits storage will automagically be registered tonconf.
Then it needs to be configured withpathandenv.
automagically klingt sehr gut ;)
|
@R5on11c Kannst Du das mal nach der neuen Anleitung testen? |
|
Hab ein paar Typos gefixed und mal durchgeschaut... Ist anwendbar. Ein anwendbares Beispiel dazu wie ein Environment-Wechsel funktioniert wäre ganz gut (persönliche Meinung). In der README.md wird |
closes #10