README.md in rubocop-performance-0.0.1 vs README.md in rubocop-performance-1.0.0
- old
+ new
@@ -1,72 +1,144 @@
-# rubocop-performance
+# RuboCop Performance
+
+[](https://circleci.com/gh/rubocop-hq/rubocop-performance)
+
+Performance optimization analysis for your projects, as an extension to [RuboCop](https://github.com/rubocop-hq/rubocop).
+
+## Installation
+
+Just install the `rubocop-performance` gem
+
+```sh
+gem install rubocop-performance
+```
+
+or if you use bundler put this in your `Gemfile`
+
+```ruby
+gem 'rubocop-performance'
+```
+
+## Usage
+
+You need to tell RuboCop to load the Performance extension. There are three
+ways to do this:
+
+### RuboCop configuration file
+
+Put this into your `.rubocop.yml`.
+
+```yaml
+require: rubocop-performance
+```
+
+Now you can run `rubocop` and it will automatically load the RuboCop Performance
+cops together with the standard cops.
+
+### Command line
+
+```sh
+rubocop --require rubocop-performance
+```
+
+### Rake task
+
+```ruby
+RuboCop::RakeTask.new do |task|
+ task.requires << 'rubocop-performance'
+end
+```
+
+## The Cops
+
+All cops are located under
+[`lib/rubocop/cop/performance`](lib/rubocop/cop/performance), and contain
+examples/documentation.
+
+In your `.rubocop.yml`, you may treat the Performance cops just like any other
+cop. For example:
+
+```yaml
+Performance/Size:
+ Exclude:
+ - lib/example.rb
+```
+
+## Contributing
+
+Checkout the [contribution guidelines](CONTRIBUTING.md).
+
+## License
+
+`rubocop-performance` is MIT licensed. [See the accompanying file](LICENSE.txt) for
+the full text.