README.md in arli-0.2.1 vs README.md in arli-0.2.2

- old
+ new

@@ -4,11 +4,11 @@ Arli is a simple and easy to use installer of dependencies that can be declared in a JSON file of the following format: -```json +```js { "dependencies": [ { "name": "DS1307RTC", "git": "https://github.com/PaulStoffregen/DS1307RTC.git" @@ -41,41 +41,64 @@ ## Usage Run `arli --help` for more information: -``` +```bash Usage: arli [options] [command [options]] - -L, --lib-home HOME Specify a local directory where libraries are installed - -h, --help prints this help + -h, --help prints this help - Available Commands: +Available Commands: install : installs libraries defined in the JSON file update : updates libraries defined in the JSON file library : Install, update, or remove a single library See arli <command> --help for more information on a specific command. ``` #### Install Command -`install` is currently the only implemented command, and it should be used as follows: +Use this command to install libraries for the first time. -``` +NOTE: you are allowed to pass `-u` flag to automatically fallback +to updating any existing folders. So `arli install -u` will either install +or update all dependencies. + +```bash Description: installs libraries defined in the JSON file Usage: arli install [options] Command Options - -L, --lib-home HOME Specify a local directory where libraries are installed - -a, --arli-json FILE JSON file with dependencies (defaults to arli.json) - -h, --help prints this help + -l, --lib-home HOME Local folder where libraries are installed + Default: ~/Documents/Arduino/Libraries + -j, --json FILE JSON file with dependencies (defaults to arli.json) + -u, --update-existing Update a library that already exists + -h, --help prints this help + ``` +#### Update Command + +To upate previously checked out libraries, use the `update` command: + +``` +Description: + updates libraries defined in the JSON file + +Usage: + arli update [options] + +Command Options + -l, --lib-home HOME Local folder where libraries are installed + Default: ~/Documents/Arduino/Libraries + -j, --json FILE JSON file with dependencies (defaults to arli.json) + -h, --help prints this help +``` ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.