README.md in rephlex-0.1.0 vs README.md in rephlex-0.1.1

- old
+ new

@@ -1,37 +1,10 @@ # Rephlex -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/rephlex`. To experiment with that code, run `bin/console` for an interactive prompt. +A slightly opinionated, this framework centers around resource allocations and locality of behavior. For example a resource like "post" and all the logic centered around decorators/routes/data-model/view components will all like in the same directory. -TODO: Delete this and the text above, and describe your gem +This framework provides some small code generation tooling, code reloading, and modern a frontend solution in vite-ruby. This framework is purposefully small, and fast. Leaning on Roda's routing tree and Sequel as the ORM you can use the plugin systems to only load in the code you truly need. -## Installation +With Roda and Sequel clocking in as the fastest ruby routing system and ORM respectively, they are complimented on the view layer with Phlex components, the fastest ruby rendering library. Leaning on evoliving tooling in the realm of hypermedia as the engine of application state, we are all-in on systems like Turbo with TurboBoost, or HTMX. -Install the gem and add to the application's Gemfile by executing: - $ bundle add rephlex - -If bundler is not being used to manage dependencies, install the gem by executing: - - $ gem install rephlex - -## Usage - -TODO: Write usage instructions here - -## Development - -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]/rephlex. 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]/rephlex/blob/main/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 Rephlex project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rephlex/blob/main/CODE_OF_CONDUCT.md). +We do not provide a large system of dsls or 'magic' for Rephlex. We strongly suggest using pure ruby and object oriented programming to solve you needs and to take care of managing your dependencies.