README.md in relinkly-1.0.1 vs README.md in relinkly-1.0.2
- old
+ new
@@ -1,6 +1,6 @@
-# relinkly
+# relinkly [](https://badge.fury.io/rb/relinkly) [](https://travis-ci.com/cyborgINX/relinkly)
## Installation
Add this line to your application's Gemfile:
@@ -55,36 +55,39 @@
```
#### Links
```ruby
api.links # GET /v1/links
-api.links(id) # GET /v1/links/:id
+api.link(id) # GET /v1/links/:id
api.link_count(options) # GET /v1/links/count
api.new_link(options) # GET /v1/links/new
api.shorten(destination, options) # POST /v1/links
api.update_link(id, options) # POST /v1/links/:id
api.delete_link(id, options) # DELETE /v1/links/:id
api.tags_link(id, options) # GET /v1/links/:id/tags
```
-#### Make a new branded short link
+#### Creating your branded short link!
```ruby
my_domain = api.domains.first
link = api.shorten('https://google.com', domain: my_domain.to_h, title: 'Google', description: 'Google Homepage')
```
#### Workspace workaround
-Please see the applicable methods for options available when making requests. In case of new link creation, default workspace is selected if workspace isn't mentioned explictly.
-Please pass the workspace_id in the options as follows in case you want to create branded link to another workspace.
+Please see the applicable methods for options available when making requests. You need to pass the workspace_id in the options as follows in case you want to perform operations other than the default workspace.
+Here's how you can create a link into another workspace.
+
```ruby
my_domain = api.domains.first
my_workspace_id = api.workspaces.first.id
link = api.shorten('https://google.com', domain: my_domain.to_h, title: 'Google', description: 'Google Homepage', workspace: my_workspace_id)
```
-Please note that `my_domain` should already be included inside `my_workspace`. You can find all the details about your workspace by going here. https://app.rebrandly.com/workspaces
+Please note that `my_domain` should already be included inside `my_workspace`. Similarly other operations on link and tags can be achieved as above.
+
+You can find all the details about your workspace by going here. https://app.rebrandly.com/workspaces
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/cdrrazan/relinkly.