Skip to content

Commit

Permalink
updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
iotshaman committed Jan 5, 2022
1 parent e6e3352 commit 1a943ac
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,10 @@ For example, if you have a node js solution that includes a library, a database
"name": "sample-library",
"environment": "node",
"type": "library",
"path": "library"
"path": "library",
"include": [
"sample-database"
]
},
{
"name": "sample-server",
Expand Down Expand Up @@ -133,4 +136,8 @@ shaman build [environment] [solutionFilePath]
**[environment]:** Indicates the coding environment, which will help determine how to build the projects. Available values are: *node*
**[solutionFilePath]:** (Optional) relative path to the shaman.json file (including file name). If no value is provided, the default value is the current working directory.

*Note: In order for the build command to work, each project needs to have a script (in package.json) called "build". If you used Shaman CLI to scaffold your code, this is already available.*
*Note: In order for the build command to work, each project needs to have a script (in package.json) called "build". If you used Shaman CLI to scaffold your code, this is already available.*

## Project Dependencies

Sometimes, one project in a solution will be dependent on another project; when this happens, you may need to instruct the Shaman CLI about these dependencies. If you know these project dependencies when scaffolding a solution (using Shaman CLI), you can simply define these dependencies in your [solution file](#solution-file) by adding the name of the *dependent* project to the "include" property of the *parent* project; then, when you run the "scaffold-solution" command if will automatically install these dependencies and future builds will know the correct order. If you **do not** know the project dependencies when scaffolding, or you do not use the Shaman CLI to scaffold your code, you will need to manually install your dependencies in any *parent* project's package.json file, then update your solution file to reflect the relationship.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "shaman-cli",
"version": "1.0.3",
"version": "1.0.4",
"description": "CLI to perform common tasks, like scaffolding source code.",
"main": "dist/index.js",
"typings": "public_api.d.ts",
Expand Down

0 comments on commit 1a943ac

Please sign in to comment.