README.md in wcc-contentful-1.0.0.pre.rc3 vs README.md in wcc-contentful-1.0.0
- old
+ new
@@ -1,7 +1,7 @@
[](https://rubygems.org/gems/wcc-contentful)
-[](https://travis-ci.org/watermarkchurch/wcc-contentful)
+[](https://circleci.com/gh/watermarkchurch/wcc-contentful)
[](https://coveralls.io/github/watermarkchurch/wcc-contentful?branch=master)
Full documentation: https://watermarkchurch.github.io/wcc-contentful/latest/wcc-contentful/
# WCC::Contentful
@@ -10,11 +10,24 @@
Table of Contents:
1. [Why?](#why-did-you-rewrite-the-contentful-ruby-stack)
2. [Installation](#installation)
+3. [Configuration](#configure)
+4. [Usage](#usage)
+ 1. [Model API](#wcccontentfulmodel-api)
+ 2. [Store API](#store-api)
+ 3. [Direct CDN client](#direct-cdn-api-simpleclient)
+ 4. [Accessing the APIs](#accessing-the-apis-within-application-code)
+5. [Architecture](#architecture)
+6. [Test Helpers](#test-helpers)
+7. [Advanced Configuration Example](#advanced-configuration-example)
+8. [Development](#development)
+9. [Contributing](#contributing)
+10. [License](#license)
+
## Why did you rewrite the Contentful ruby stack?
We started working with Contentful almost 3 years ago. Since that time, Contentful's ruby stack has improved, but there are still a number of pain points that we feel we have addressed better with our gem. These are:
* [Low-level caching](#low-level-caching)
@@ -310,11 +323,11 @@
end
```
## Architecture
-
+
## Test Helpers
To use the test helpers, include the following in your rails_helper.rb:
@@ -452,14 +465,14 @@
After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/watermarkchurch/wcc-contentful. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/watermarkchurch/wcc-contentful.
-## License
+The developers at Watermark Community Church have pledged to govern their interactions with each other, with their clients, and with the larger wcc-contentful user community in accordance with the "instruments of good works" from chapter 4 of The Rule of St. Benedict (hereafter: "The Rule"). This code of ethics has proven its mettle in thousands of diverse communities for over 1,500 years, and has served as a baseline for many civil law codes since the time of Charlemagne.
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+[See the full Code of Ethics](https://github.com/watermarkchurch/wcc-contentful/blob/master/CODE_OF_ETHICS.md)
-## Code of Conduct
+## License
-Everyone interacting in the WCC::Contentful project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/watermarkchurch/wcc-contentful/blob/master/CODE_OF_CONDUCT.md).
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).