README.md in hanami-0.9.1 vs README.md in hanami-0.9.2
- old
+ new
@@ -1,98 +1,80 @@
-# Hanami
+[](http://badge.fury.io/rb/hanami)
+[](http://travis-ci.org/hanami/hanami?branch=master)
+[](https://coveralls.io/r/hanami/hanami)
+[](https://codeclimate.com/github/hanami/hanami)
+[](https://gemnasium.com/hanami/hanami)
+[](http://inch-ci.org/github/hanami/hanami)
+# Hanami :cherry_blossom:
+
The web, with simplicity.
## Frameworks
-Hanami combines small yet powerful frameworks:
+Hanami is a **full-stack** Ruby web framework.
+It's made up of smaller, single-purpose libraries.
-* [**Hanami::Utils**](https://github.com/hanami/utils) - Ruby core extensions and class utilities
-* [**Hanami::Router**](https://github.com/hanami/router) - Rack compatible HTTP router for Ruby
+This repository is for the full-stack framework,
+which provides the glue that ties all the parts together:
+
+* [**Hanami::Model**](https://github.com/hanami/model) - Persistence with entities, repositories and data mapper
+* [**Hanami::View**](https://github.com/hanami/view) - Presentation with a separation between views and templates
+* [**Hanami::Controller**](https://github.com/hanami/controller) - Full featured, fast and testable actions for Rack
* [**Hanami::Validations**](https://github.com/hanami/validations) - Validations mixin for Ruby objects
+* [**Hanami::Router**](https://github.com/hanami/router) - Rack compatible HTTP router for Ruby
* [**Hanami::Helpers**](https://github.com/hanami/helpers) - View helpers for Ruby applications
* [**Hanami::Mailer**](https://github.com/hanami/mailer) - Mail for Ruby applications
-* [**Hanami::Model**](https://github.com/hanami/model) - Persistence with entities, repositories and data mapper
* [**Hanami::Assets**](https://github.com/hanami/assets) - Assets management for Ruby
-* [**Hanami::View**](https://github.com/hanami/view) - Presentation with a separation between views and templates
-* [**Hanami::Controller**](https://github.com/hanami/controller) - Full featured, fast and testable actions for Rack
+* [**Hanami::Utils**](https://github.com/hanami/utils) - Ruby core extensions and class utilities
These components are designed to be used independently or together in a Hanami application.
-If you aren't familiar with them, please take time to go through their READMEs.
+## Installation
+__Hanami__ supports Ruby (MRI) 2.3+
+
+```shell
+gem install hanami
+```
+
+## Usage
+
+```shell
+hanami new bookshelf
+cd bookshelf && bundle
+bundle exec hanami server # visit http://localhost:2300
+```
+
+Please follow along with the [Getting Started guide](http://hanamirb.org/guides/getting-started).
+
## Donations
You can give back to Open Source, by supporting Hanami development via a [donation](https://salt.bountysource.com/teams/hanami). :green_heart:
### Supporters
* [James Carlson](https://github.com/jxxcarlson)
-## Status
-
-[](http://badge.fury.io/rb/hanami)
-[](http://travis-ci.org/hanami/hanami?branch=master)
-[](https://coveralls.io/r/hanami/hanami)
-[](https://codeclimate.com/github/hanami/hanami)
-[](https://gemnasium.com/hanami/hanami)
-[](http://inch-ci.org/github/hanami/hanami)
-
## Contact
* Home page: http://hanamirb.org
* Community: http://hanamirb.org/community
* Guides: http://hanamirb.org/guides
* Mailing List: http://hanamirb.org/mailing-list
* API Doc: http://rdoc.info/gems/hanami
* Bugs/Issues: https://github.com/hanami/hanami/issues
-* Support: http://stackoverflow.com/questions/tagged/hanami
-* Forum: https://discuss.hanamirb.org
-* Chat: http://chat.hanamirb.org
+* Stack Overflow: http://stackoverflow.com/questions/tagged/hanami
+* Forum: https://discourse.hanamirb.org
+* **Chat**: http://chat.hanamirb.org
-## Rubies
-
-__Hanami__ supports Ruby (MRI) 2.3+
-
-## Installation
-
-```shell
-% gem install hanami
-```
-
-## Usage
-
-```shell
-% hanami new bookshelf
-% cd bookshelf && bundle
-% bundle exec hanami server # visit http://localhost:2300
-```
-
-Please follow along with the [Getting Started guide](http://hanamirb.org/guides/getting-started).
-
## Community
-We strive for a Community made of **inclusive, helpful and smart people**.
+We strive for an inclusive and helpful community.
We have a [Code of Conduct](http://hanamirb.org/community/#code-of-conduct) to handle controversial cases.
In general, we expect **you** to be **nice** with other people.
Our hope is for a great software and a great Community.
-### Contributor Code of Conduct
-
-As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
-
-Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
-
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
-
-This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
-
-This Code of Conduct is adapted from the Contributor Covenant, version 1.1.0, available from http://contributor-covenant.org/version/1/1/0/
-
## Contributing
1. Fork it ( https://github.com/hanami/hanami/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
@@ -114,36 +96,37 @@
### Development Requirements
* Ruby 2.3+ / JRuby 9.1.5.0+
* Bundler
- * Qt (MacOS)
+ * [PhantomJS](http://phantomjs.org/download.html)
* Node.js (MacOS)
### Testing
In order to simulate installed gems on developers' computers, the build installs
all the gems locally in `vendor/cache`, including `hanami` code from `lib/`.
**Before running a test, please make sure you have a fresh version of the code:**
```shell
-% ./script/setup
-% bundle exec rspec spec/path/to/file_spec.rb
+./script/setup
+bundle exec rspec spec/path/to/file_spec.rb
```
-### Build / CI
-
To run all the tests, please use:
```shell
-% ./script/ci
+./script/ci
```
## Versioning
__Hanami__ uses [Semantic Versioning 2.0.0](http://semver.org)
## Copyright
-Copyright © 2014-2016 Luca Guidi – Released under MIT License
+Released under MIT License.
+
This project was formerly known as Lotus (`lotusrb`).
+
+Copyright © 2014-2016 Luca Guidi.