README.md in permadeps-1445.12 vs README.md in permadeps-1445.12.1

@@ -1,39 +1,67 @@
-# Permadeps
+# permadeps
 
-TODO: Delete this and the text below, and describe your gem
+Ruby gem holds my permanent dependencies and configs I'm using in my Rails projects.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/permadeps`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem is compatible with [this](https://github.com/AliOsm/ruby-on-rails-devcontainer) DevContainer setup.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Install the gem and add it to the Rails application's Gemfile by executing:
 
-Install the gem and add to the application's Gemfile by executing:
+```bash
+$ bundle add permadeps
+```
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+## Usage
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Adding this gem to your Rails project will provide you with the following gems:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+### Production dependencies:
+- [`better_html`](https://github.com/Shopify/better-html) (Will be required)
+- [`flamegraph`](https://github.com/SamSaffron/flamegraph) (Will be required)
+- [`freezolite`](https://github.com/ruby-next/freezolite)
+- [`memory_profiler`](https://github.com/SamSaffron/memory_profiler) (Will be required)
+- [`rack-mini-profiler`](https://github.com/MiniProfiler/rack-mini-profiler) (Will be required)
+- [`stackprof`](https://github.com/tmm1/stackprof) (Will be required)
 
-## Usage
+### Development dependencies:
+- [`annotaterb`](https://github.com/drwl/annotaterb)
+- [`better_errors`](https://github.com/BetterErrors/better_errors)
+- [`binding_of_caller`](https://github.com/banister/binding_of_caller)
+- [`brakeman`](https://github.com/presidentbeef/brakeman)
+- [`bullet`](https://github.com/flyerhzm/bullet) (Will be required in development environment only)
+- [`bundler-audit`](https://github.com/rubysec/bundler-audit)
+- [`dotenv`](https://github.com/bkeepers/dotenv)
+- [`erb-formatter`](https://github.com/nebulab/erb-formatter)
+- [`erb_lint`](https://github.com/Shopify/erb-lint)
+- [`i18n-tasks`](https://github.com/glebm/i18n-tasks)
+- [`rubocop`](https://github.com/rubocop/rubocop)
+- [`rubocop-minitest`](https://github.com/rubocop/rubocop-minitest)
+- [`rubocop-performance`](https://github.com/rubocop/rubocop-performance)
+- [`rubocop-rails`](https://github.com/rubocop/rubocop-rails)
+- [`rubocop-rake`](https://github.com/rubocop/rubocop-rake)
+- [`rubocop-rspec`](https://github.com/rubocop/rubocop-rspec)
+- [`rubocop-rspec_rails`](https://github.com/rubocop/rubocop-rspec_rails)
+- [`ruby_audit`](https://github.com/civisanalytics/ruby_audit)
 
-TODO: Write usage instructions here
+#### Rubocop
 
-## Development
+For `rubocop` gem, use the following configuration file to inherit from `permadeps` gem:
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```yml
+inherit_gem:
+  permadeps:
+    - .rubocop.yml
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+#### Formatters
 
-## Contributing
+`erb-formatter` and `erb_lint` requires the following VSCode extensions to work properly:
+- [Ruby ERB::Formatter](https://marketplace.visualstudio.com/items?itemName=elia.erb-formatter)
+- [ERB Linter](https://marketplace.visualstudio.com/items?itemName=manuelpuyol.erb-linter)
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/permadeps. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/permadeps/blob/master/CODE_OF_CONDUCT.md).
+Make sure to setup the other gems properly in your Rails application.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Permadeps project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/permadeps/blob/master/CODE_OF_CONDUCT.md).