Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation problems #4

Open
ibrido90 opened this issue Aug 31, 2016 · 0 comments
Open

Documentation problems #4

ibrido90 opened this issue Aug 31, 2016 · 0 comments

Comments

@ibrido90
Copy link

ibrido90 commented Aug 31, 2016

Hi i don't want to be too rude about this but actually there are some problems in your docs.
First things first. I really like your job about this tool but this is intended to help you and other save time (no anger :) ). So... :

  1. Please explain the difference (if any) between fromConfig and fromNodeConfig functions

  2. baseDir does not exist, instead it's called basePath

  3. now the example (in wich i used fromConfig):

    1. first of all fromConfig expects an object like this:

      ...
      
      var opts = {
          config: /*retrieve config file*/,
          basePath: process.cwd() /*or whatever it is*/
      }
      
      var di = amend.fromConfig(opts);
      
      ...
      
    2. You created a file called playGame.js but in config.json was refereneced as play-game.js

    3. Even for 'custom' modules, in node is not necessary to specify the extension of your file so the config.json can be rewritten as:

          {
              "modules": {
                  "rollDice": "./roll-dice",
                  "playGame": "./playGame",
                  "_": {
                      "require": "lodash",
                      "type": "value"
                  }
              }
          }
          ```
    
    Anyway very good work about this module.
    
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant