README.md in tracker_api-1.0.0 vs README.md in tracker_api-1.1.0
- old
+ new
@@ -57,12 +57,15 @@
story.save # Save changes made to a story
story = TrackerApi::Resources::Story.new( client: client,
project_id: 123456,
id: 847762630) # Use the Story resource to get the story
-comments = story.comments # comments without first fetching the story.
+comments = story.comments # comments without first fetching the story
+task = story.tasks.first # Get story tasks
+task.complete = true
+task.save # Mark a task complete
epics = project.epics # Get all epics for a project
epic = epics.first
label = epic.label # Get an epic's label
```
@@ -83,9 +86,20 @@
## TODO
- Add missing resources and endpoints
- Add create, update, delete for resources
+
+## Semantic Versioning
+http://semver.org/
+
+Given a version number MAJOR.MINOR.PATCH, increment the:
+
+1. MAJOR version when you make incompatible API changes,
+2. MINOR version when you add functionality in a backwards-compatible manner, and
+3. PATCH version when you make backwards-compatible bug fixes.
+
+Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
## Contributing
Currently this client supports read-only access to Pivotal Tracker.
We will be extending it as our use cases require, but are always happy to accept contributions.