@idearium/cli - npm Package Compare versions

Comparing version 1.0.0-alpha.3 to 1.0.0-alpha.4

CHANGELOG.md

@@ -9,5 +9,5 @@ # @ideariym/cli
 
-## Bugs
+### Bugs
 
-Fixed an issue with `package.json`.
+- Fixed an issue with `package.json`.
 
@@ -14,0 +14,0 @@ ## 1.0.0-alpha.2

package.json

 {
   "name": "@idearium/cli",
-  "version": "1.0.0-alpha.3",
+  "version": "1.0.0-alpha.4",
   "description": "The Idearium cli, which makes working with our projects much easier.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -1,2 +0,27 @@
-# cli
+# @idearium/cli
+
 The Idearium cli, which makes working with our projects, super easy :)
+
+## Documentation
+
+The cli is self documenting and you'll find limited information about the commands within the cli here.
+
+## Install
+
+Via NPM:
+
+```
+$ npm install -DE [-g] @idearium/cli
+```
+
+We actually recommend installing `@idearium/cli` locally in your project. This allows each project to use a different version of the cli. If you do however, we also recommend adding `./node_modules/.bin` to your path, so that you can run the cli via `c` without a global install.
+
+## Usage
+
+Once installed, simply run `c`, and you'll get the help output for all commands. Running a sub-command and then `--help` will give you the help output for that command (i.e. `c dc --help`).
+
+## Commands
+
+The following is a summary of the top level commands.
+
+- `c dc` is for everything Docker Compose.

No alert changes

Improved metrics

Total package byte prevSize

13344

increased by15.03%

Number of package files

18

increased by5.88%

Number of lines in readme file

28

increased by833.33%

No dependency changes