Add documentation

README.md

@@ -1,28 +1,125 @@
-# Rails::AppEnv
-Short description and motivation.
+<div align="center">
 
-## Usage
-How to use my plugin.
+# Rails APP_ENV
 
-## Installation
-Add this line to your application's Gemfile:
+[![Gem Version](https://img.shields.io/gem/v/rails-app_env)](https://badge.fury.io/rb/rails-app_env)
+[![CI](https://github.com/typisttech/rails-app_env/actions/workflows/ci.yml/badge.svg)](https://github.com/typisttech/rails-app_env/actions/workflows/ci.yml)
+[![License](https://img.shields.io/github/license/typisttech/rails-app_env.svg)](https://github.com/typisttech/rails-app_env/blob/master/LICENSE.txt)
+[![Follow @TangRufus on X](https://img.shields.io/badge/Follow-TangRufus-15202B?logo=x&logoColor=white)](https://x.com/tangrufus)
+[![Follow @TangRufus.com on Bluesky](https://img.shields.io/badge/Bluesky-TangRufus.com-blue?logo=bluesky)](https://bsky.app/profile/tangrufus.com)
+[![Sponsor @TangRufus via GitHub](https://img.shields.io/badge/Sponsor-TangRufus-EA4AAA?logo=githubsponsors)](https://github.com/sponsors/tangrufus)
+[![Hire Typist Tech](https://img.shields.io/badge/Hire-Typist%20Tech-778899)](https://typist.tech/contact/)
+
+<p>
+  <strong>
+    <code>Rails APP_ENV</code> is like <code>RAILS_ENV</code> but for configurations only.
+  </strong>
+  <br>
+  <br>
+  Built with ♥ by <a href="https://typist.tech/">Typist Tech</a>
+</p>
+
+</div>
+
+---
+
+## Quick Start
+
+TODO.
+
+## Why
+
+TODO.
+
+## `RAILS_ENV` vs `APP_ENV`
+
+TODO.
+
+## Features
+
+### `Rails.app_env`
+
+`Rails.app_env` is like `Rails.env` but it is set by the `APP_ENV` environment variable (`ENV["APP_ENV"]`).
+
+It is optimization for `staging` and `review` ([the two extra Heroku pipeline stages](https://devcenter.heroku.com/articles/pipelines)),
+so it doesn't need to rely on the slower delegation through `method_missing` that `ActiveSupport::EnvironmentInquirer`
+would normally entail.
 
 ```ruby
-gem "rails-app_env"
+## Assume we booted Rails with `APP_ENV=staging RAILS_ENV=production`
+Rails.app_env # => "staging"
+Rails.app_env.staging? # => true
+Rails.app_env.production? # => false
+Rails.app_env.any_other_predicate? # => false
+
+Rails.env # => "production"
+Rails.env.staging? # => false
+Rails.env.production? # => true
 ```
 
-And then execute:
-```bash
-$ bundle
+In case `ENV["APP_ENV"]` is blank, `Rails.app_env` falls back to `Rails.env`.
+
+### Credentials
+
+`Rails APP_ENV` overrides the default Rails credentials `content_path` and `key_path` according to `Rails.app_env`.
+
+Given the following `*.yml.enc` and `*.key` files under `config/credentials/`, `APP_ENV=staging RAILS_ENV=production`
+would load the credentials from `config/credentials/staging.yml.enc` and `config/credentials/staging.key`.
+
+```console
+$ tree config/credentials
+config/credentials
+├── production.key
+├── production.yml.enc
+├── staging.key
+└── staging.yml.enc
 ```
 
-Or install it yourself as:
+In case `config/credentials/#{Rails.app_env}.yml.enc` does not exist, it falls back to `config/credentials.yml.enc`.
+
+In case `config/credentials/#{Rails.app_env}.key` does not exist, it falls back to `config/master.key`.
+
+As with default Rails behaviours, if `ENV["RAILS_MASTER_KEY"]` is present, it takes precedence over
+`config/credentials/#{Rails.app_env}.key` and `config/master.key`.
+
+Learn more in the [Heroku](#heroku) section below.
+
+### Console
+
+Whenever Rails console is started, `Rails APP_ENV` prints the current `Rails.app_env` and gem version to the console.
+
+If the `Rails.app_env` differs from `Rials.env`, `Rails APP_ENV` appends `Rails.app_env` to the console prompt.
+
+![rails console](docs/screenshot-rails-console.jpg)
+
+## Heroku
+
+TODO.
+
+## Installation
+
+Install the gem and add to the application's `Gemfile` or `gems.rb` by executing:
+
 ```bash
-$ gem install rails-app_env
+bundle add rails-app_env
 ```
 
-## Contributing
-Contribution directions go here.
+## Prior Art
+
+- [anyway_config](https://github.com/palkan/anyway_config)
+
+## Credits
+
+[`Rails APP_ENV`](https://github.com/typisttech/rails-app_env) is a [Typist Tech](https://typist.tech) project and
+maintained by [Tang Rufus](https://x.com/TangRufus), freelance developer [for hire](https://typist.tech/contact/).
+
+Full list of contributors can be found [on GitHub](https://github.com/typisttech/rails-app_env/graphs/contributors).
+
+## Copyright and License
+
+This project is a [free software](https://www.gnu.org/philosophy/free-sw.en.html) distributed under the terms of
+the MIT license. For the full license, see [LICENSE](LICENSE).
+
+## Contribute
 
-## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Feedbacks / bug reports / pull requests are welcome.

rails-app_env.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.authors = ["Typist Tech Limited", "Tang Rufus"]
   spec.email = ["opensource+swagger_ui_standalone@typist.tech", "tangrufus@gmail.com"]
 
-  spec.summary = "Summary of Rails::AppEnv."
+  spec.summary = "Rails APP_ENV is like RAILS_ENV but for configurations only."
   spec.homepage = "https://github.com/typisttech/rails-app_env"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 3.2.0"