@agility/cli - npm Package Compare versions

Comparing version 0.0.5 to 0.0.6

package.json

 {
   "name": "@agility/cli",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "Agility CLI for working with your content.",
@@ -5,0 +5,0 @@ "repository": {

README.md

@@ -12,8 +12,18 @@ # Agility CLI
 
-### Prerequisites
+### Installation
+#### Using npm
+1. To install the cli locally using npm, open terminal and type: ```npm i @agility/cli```.
+2. For global installation using npm, open terminal and type: ```npm i @agility/cli -g```.
+
+#### Using yarn
+1. To install the cli locally using yarn, open terminal and type: ```yarn add @agility/cli```.
+2. For global installation using yarn, open terminal and type: ```yarn global add @agility/cli```.
+
+### Using the CLI
+#### Athenticate first
 1. Login to agility instance using command ```agility login```.
-2. Once authenticated use the following steps to perform operations on your instance.
-3. Should have an instance pulled first to push to a target instance.
+2. A browser window will appear to perform the authentication process. You may have to authorize before proceeding.
+3. Once authenticated use the following steps to perform operations on your instance.
 
-### Steps
+#### Performing operations on CLI
 1. To pull an instance use the command ```agility pull --guid="<<Provide Guid of your Instance>>" --locale="<<Provide the locale of the Instance>>" --channel="<<Provide the channel to be pulled>>"``` to pull an instance.
@@ -24,3 +34,3 @@ 2. To push an instance use the command ```agility push --guid="<<Provide the target Instance guid>> --locale="<<Provide the locale of the Instance>>"```
 
-## Folder Structure
+#### Folder Structure
 1. If a pull or clone instance is initiated, a local folder .agility-files is created.
@@ -27,0 +37,0 @@ 2. Assets are saved inside the assets folder which consists of a json folder which has the metadata of the assets downloaded. The folder structure is .agility-files/assets/json for metadata. Rest assets are present inside the assets folder.

No alert changes

Improved metrics

Total package byte prevSize

197383

increased by0.27%

Number of lines in readme file

60

increased by20%

No dependency changes