bwcli 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef8e740832b3c56470d00e388264cefe5c4cfed0
-  data.tar.gz: 694d79bd4663a392de3e750479ea5ea8041aa10c
+  metadata.gz: 9e15631f5cdedfa5c88e9af176bda6b7194663b0
+  data.tar.gz: c27fdb56c9a3f429df0ba250ffc5090dcc973a51
 SHA512:
-  metadata.gz: 7c69167c5cdfa29a040411883155782e9fcaf7573646ef602a778b2ba1cfb56c7963b90a7bbda4800338d57c91dd96ff6e5aca3cedd7449b4f0fe55202b24779
-  data.tar.gz: c7f23b04f08e6daba85fa965080b5db1bb24385625cbc7f97870d019fb5ebadd72188030cc601bff2d149e4c6e42dffdcb460599adc788461c88c1952c30e928
+  metadata.gz: c97aaf895b4ffd8e10cea2e971235764d286259ff8310d2f2b67cdd1a4b1a6313630efb3e11b3cf490390749d692819921e400c714b5ddc1138cbbc573b805e8
+  data.tar.gz: 17c7f4491173aa6d7322e1b4b9f5d2bf997fc728142ff5c406b69cca76645109a89bab42646c8c366fd7cc88f4940b55bf10c2ec521442cc26a32e85a56e4041

data/README.md

@@ -9,3 +9,99 @@ __PLEASE NOTE THAT THIS PROJECT IS NOT OFFICIALLY SUPPORTED BY BRANDWATCH__
 A command line interface to interact with the Brandwatch API
 
 
+## Documentation 
+http://rubydoc.info/gems/bwcli/
+
+## Getting Started
+
+In order to interact with the `BWAPI` from the command line we first need to setup a current user in the `.bwcli` config file. Please note that the config file enables us to hold multiple users which we can easily switch between.
+
+### Add new user to config
+
+In order to use `bwcli` you need to have a `.bwcli` file in your root directory, don't worry I've got your back. When you create a new user the file will be created automatically. So, to get the show on the road add a user to your config file:
+
+```ruby
+bwcli config add -u username@domain.com -p your_password -e enviroment
+```
+
+When you create a user for the first time `bwcli` will automatically set this user as your `current user`. When you add new users to your config, `bwcli` will ask whether you want to set this user as your current user.
+
+### View user config
+
+Returns the users currently stored in the config file along with the current user if set.
+
+```ruby
+bwcli config list
+```
+
+### Set current user
+
+Sets the user as the current user. The `set` or `switch` command can be used.
+
+```ruby
+bwcli config set -u anotheruser@domain -e environment
+```
+
+### Remove user
+
+Removes the specific user from the config file, no warning is given.
+
+```ruby
+bwcli config remove -u anotheruser@domain -e environment
+```
+
+### View current user
+
+Returns the current user set in the config file.
+
+```ruby
+bwcli config user
+```
+
+### Authenticate current user
+
+Please note that when ever you make a request to an endpoint `bwcli` will ensure you are authenticated with brandwatch so the login command doesn't need to run everytime.
+
+```ruby
+bwcli config login
+```
+
+### Reset user config
+
+Wipe your config file and restart, warning is given and the user must respond with a `yes` or `y` to confirm.
+
+```ruby
+bwcli config reset
+```
+
+## Next Steps
+
+Once you have your current user setup you can make API requests to Brandwatch. Currently at present only the `me` and `projects` endpoint are implemented.
+
+### Me Endpoint
+
+Returns user information.
+
+```ruby
+bwcli me
+```
+
+### All Projects
+
+Returns all projects the user currently has shared.
+
+
+```ruby
+bwcli projects
+```
+
+### Specific Projects
+
+Returns the specific project specified, user must pass option for `-i` parameter.
+
+```ruby
+bwcli projects -i 12345678
+```
+
+## Feedback
+I would be more than happy to recieve feedback, please email me at: jonathan.chrisp@gmail.com or jonathan@brandwatch.com

data/lib/bwcli/version.rb

@@ -1,3 +1,3 @@
 module BWCLI
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bwcli
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Jonathan Chrisp
@@ -108,7 +108,6 @@ files:
 - bin/bwcli
 - bwcli.gemspec
 - lib/bwcli.rb
-- lib/bwcli/.DS_Store
 - lib/bwcli/config.rb
 - lib/bwcli/configuration.rb
 - lib/bwcli/me.rb