Skip to content

Commit

Permalink
Update README state of the project: remove 0.6 and comment on using p…
Browse files Browse the repository at this point in the history
…re5.
  • Loading branch information
varyonic committed Mar 15, 2017
1 parent fd0612d commit b7555b7
Showing 1 changed file with 16 additions and 39 deletions.
55 changes: 16 additions & 39 deletions README.md
@@ -1,6 +1,6 @@
# Active Admin

Active Admin is a Ruby on Rails framework for creating elegant backends for website administration.
[Active Admin](https://www.activeadmin.info) is a Ruby on Rails framework for creating elegant backends for website administration.

[![Version ](http://img.shields.io/gem/v/activeadmin.svg) ](https://rubygems.org/gems/activeadmin)
[![Travis CI ](http://img.shields.io/travis/activeadmin/activeadmin/master.svg) ](https://travis-ci.org/activeadmin/activeadmin)
Expand All @@ -10,45 +10,16 @@ Active Admin is a Ruby on Rails framework for creating elegant backends for webs

## State of the project

### 1.0.0
1.0.0.pre5 is the last release to support Rails 3.2 and Ruby 2.0 or earlier.
It is provided to help with upgrades to Rails 4 only.

We're [currently working on 1.0.0](https://github.com/activeadmin/activeadmin/issues?milestone=18),
which as far as dependencies, moves us from meta_search to Ransack and adds Rails 4 & 5 support.
1.0.0.pre5 has support for Rails 5. The following Gemfile addition may be needed:

You can get it by tracking master:
```ruby
gem 'activeadmin', git: 'https://github.com/activeadmin/activeadmin'
gem 'inherited_resources', '~> 1.7'
```

Or you can using rubygems:
```ruby
gem 'activeadmin', '~> 1.0.0.pre5'
```

*Keep in mind that during the time where we use `pre`-release label, things can break in each release!*

### 0.6.x

The plan is to follow [semantic versioning](http://semver.org/) as of 1.0.0. The 0.6.x line will
still be maintained, and we will backport bug fixes into future 0.6.x releases. If you don't want
to have to wait for a release, you can track the branch instead:

```ruby
gem 'activeadmin', git: 'https://github.com/activeadmin/activeadmin', branch: '0-6-stable'
```

## Documentation

For the latest docs, check out the Github <http://activeadmin.info> and the [wiki](https://github.com/activeadmin/activeadmin/wiki).

## Links

* Website: <http://activeadmin.info>
* Live demo: <http://demo.activeadmin.info/admin>
* Documentation
* Guides: <https://github.com/activeadmin/activeadmin/tree/master/docs>
* YARD: <http://rubydoc.info/gems/activeadmin>
* Wiki: <https://github.com/activeadmin/activeadmin/wiki>
1.0.0 will drop support for Rails 3.2 and Ruby 2.0 or earlier.

## Goals

Expand All @@ -58,13 +29,19 @@ For the latest docs, check out the Github <http://activeadmin.info> and the [wik

## Getting started

Check out [the docs](http://activeadmin.info/0-installation.html)!
* Check out [the docs](http://activeadmin.info/0-installation.html)!
* Try the [live demo](http://demo.activeadmin.info/admin)
* The [wiki](https://github.com/activeadmin/activeadmin/wiki) includes links to tutorials, articles and sample projects.

## Need help?

Ask us in IRC ([#activeadmin](https://webchat.freenode.net/?channels=activeadmin)), on the
[mailing list](http://groups.google.com/group/activeadmin), or on
[Stack Overflow](http://stackoverflow.com/questions/tagged/activeadmin).
Please use [StackOverflow](http://stackoverflow.com/questions/tagged/activeadmin) for
help requests and how-to questions.

Please open GitHub issues for bugs and enhancements only, not general help requests.
Please search previous issues (and Google and StackOverflow) before creating a new issue.

Google Groups, IRC #activeadmin and Gitter are not actively monitored.

## Want to contribute?

Expand Down

0 comments on commit b7555b7

Please sign in to comment.