README.md in phlex-rails-0.1.0 vs README.md in phlex-rails-0.2.0
- old
+ new
@@ -1,43 +1,27 @@
-# Phlex::Rails
+<a href="https://www.phlex.fun"><img alt="Phlex logo" src="phlex_logo.png" width="180" /></a>
-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/phlex/rails`. To experiment with that code, run `bin/console` for an interactive prompt.
+Phlex is a framework that lets you compose web views in pure Ruby.
-TODO: Delete this and the text above, and describe your gem
+### Documentation 📗
-## Installation
+Documentation can be found at [www.phlex.fun](https://www.phlex.fun).
-Add this line to your application's Gemfile:
+### Support ✋
-```ruby
-gem 'phlex-rails'
-```
+If you run into any trouble, please [start a discussion](https://github.com/joeldrapper/phlex/discussions/new), or [open an issue](https://github.com/joeldrapper/phlex/issues/new) if you think you’ve found a bug.
-And then execute:
+### Community 🙌
- $ bundle install
+Everyone interacting in Phlex codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/joeldrapper/phlex/blob/main/CODE_OF_CONDUCT.md).
-Or install it yourself as:
+### Sponsorship 💖
- $ gem install phlex-rails
+Maintaining a library is a lot of work. If your company benefits from this work or is likely to benefit from it in the future, please consider [sponsorship](https://github.com/sponsors/joeldrapper). Phlex is actively developed and maintained by **[Joel Drapper](https://github.com/sponsors/joeldrapper)**.
-## Usage
+### Security 🚨
-TODO: Write usage instructions here
+If you’ve found a potential security issue, please email [security@phlex.fun](mailto:security@phlex.fun).
-## Development
+### Thanks 🙏
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-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).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/phlex-rails. 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]/phlex-rails/blob/master/CODE_OF_CONDUCT.md).
-
-## 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 Phlex::Rails project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/phlex-rails/blob/master/CODE_OF_CONDUCT.md).
+Thanks [Logology](https://www.logology.co) for sponsoring our logo.