README.md in relinkly-0.1.0 vs README.md in relinkly-1.0.0
- old
+ new
@@ -33,29 +33,59 @@
api = Relinkly::API.new
```
### API Requests
+#### Account and Workspaces
```ruby
+api.domains # GET /v1/domains
+api.domain(id) # GET /v1/domains/:id
+api.domain_count(options) # GET /v1/domains/count
+api.account # GET /v1/account
+api.workspaces # GET /v1/workspaces
+```
+
+#### Tags
+```ruby
+api.tags # GET /v1/tags
+api.tags(id) # GET /v1/tags/:id
+api.tag_count(options) # GET /v1/tags/count
+api.new_tag(options) # GET /v1/tags/new
+api.update_tag(id, options) # POST /v1/tags/:id
+api.delete_tag(id, options) # DELETE /v1/tags/:id
+```
+
+#### Links
+```ruby
api.links # GET /v1/links
api.links(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(id, options) # DELETE /v1/links/:id
-api.domains # GET /v1/domains
-api.domain(id) # GET /v1/domains/:id
-api.domain_count(options) # GET /v1/domains/count
-api.account # GET /v1/account
+api.delete_link(id, options) # DELETE /v1/links/:id
+api.tags_link(id, options) # GET /v1/links/:id/tags
```
-### Make a new short link
+### Make a new 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', favourite: true)
+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 created branded link to 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
+
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/cdrrazan/relinkly.