Skip to content

Commit bca2f22

Browse files
committed
Update README for v4.1.0 release
1 parent aa916e2 commit bca2f22

1 file changed

Lines changed: 14 additions & 17 deletions

File tree

README.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
## Devise based authentication for Alchemy 4.0
1+
## Devise based authentication for Alchemy 4.1
22

33
[![Build Status](https://secure.travis-ci.org/AlchemyCMS/alchemy-devise.svg?branch=master)](http://travis-ci.org/AlchemyCMS/alchemy-devise)
44

5-
[![Gem Version](https://badge.fury.io/rb/alchemy-devise.svg)](http://badge.fury.io/rb/alchemy-devise) [![Test Coverage](https://codeclimate.com/github/AlchemyCMS/alchemy-devise/badges/coverage.svg)](https://codeclimate.com/github/AlchemyCMS/alchemy-devise/coverage) [![Code Climate](https://codeclimate.com/github/AlchemyCMS/alchemy-devise/badges/gpa.svg)](https://codeclimate.com/github/AlchemyCMS/alchemy-devise) [![security](https://hakiri.io/github/AlchemyCMS/alchemy-devise/master.svg)](https://hakiri.io/github/AlchemyCMS/alchemy-devise/master) [![Dependency Status](https://gemnasium.com/AlchemyCMS/alchemy-devise.svg)](https://gemnasium.com/AlchemyCMS/alchemy-devise)
5+
[![Gem Version](https://badge.fury.io/rb/alchemy-devise.svg)](http://badge.fury.io/rb/alchemy-devise) [![Test Coverage](https://codeclimate.com/github/AlchemyCMS/alchemy-devise/badges/coverage.svg)](https://codeclimate.com/github/AlchemyCMS/alchemy-devise/coverage) [![Code Climate](https://codeclimate.com/github/AlchemyCMS/alchemy-devise/badges/gpa.svg)](https://codeclimate.com/github/AlchemyCMS/alchemy-devise) [![security](https://hakiri.io/github/AlchemyCMS/alchemy-devise/master.svg)](https://hakiri.io/github/AlchemyCMS/alchemy-devise/master)
66

7-
**CAUTION: This master branch is a development branch that can contain bugs. For productive environments you should use the [current Ruby gem version](https://rubygems.org/gems/alchemy-devise/versions/4.0.0), or the [latest stable branch (4.0-stable)](https://github.com/AlchemyCMS/alchemy-devise/tree/4.0-stable).**
7+
**CAUTION: This master branch is a development branch that can contain bugs. For productive environments you should use the [current Ruby gem version](https://rubygems.org/gems/alchemy-devise/versions/4.1.0), or the [latest stable branch (4.1-stable)](https://github.com/AlchemyCMS/alchemy-devise/tree/4.1-stable).**
88

99
AlchemyCMS has no authentication in its core. So it is possibly to bring your own authentication and use it to authorize users in AlchemyCMS. If you don't have your own authentication, you can use this gem.
1010

@@ -17,21 +17,21 @@ Just put the gem into your projects `Gemfile`.
1717
gem 'alchemy-devise', github: 'AlchemyCMS/alchemy-devise', branch: 'master'
1818
```
1919

20-
**NOTE:** You normally want to use a stable branch, like `4.0-stable`.
20+
**NOTE:** You normally want to use a stable branch, like `4.1-stable`.
2121

2222
and run `bundle install`.
2323

2424
Then run the installer:
2525

26-
```shell
26+
```bash
2727
$ bin/rails g alchemy:devise:install
2828
```
2929

3030
## Upgrading
3131

3232
After updating the gem, please run the installer again.
3333

34-
```shell
34+
```bash
3535
$ bundle update alchemy-devise
3636
$ bin/rails g alchemy:devise:install
3737
```
@@ -74,20 +74,20 @@ Just follow these pretty rails standard way of testing projects:
7474

7575
Clone the repo to your local harddrive. Then
7676

77-
```shell
77+
```bash
7878
$ bundle install
7979
$ rake alchemy:spec:prepare
8080
```
8181

8282
### 2. Run the tests with:
8383

84-
```shell
84+
```bash
8585
$ rspec
8686
```
8787

8888
_Optional:_ Even shorter
8989

90-
```shell
90+
```bash
9191
$ rake
9292
```
9393

@@ -97,20 +97,17 @@ Getting Help
9797
------------
9898

9999
* If you have bugs, please use the [issue tracker on Github](https://github.com/AlchemyCMS/alchemy-devise/issues).
100-
* For Q&A and general usage, please use the [User Group](http://groups.google.com/group/alchemy-cms) or the IRC channel.
101-
* New features should be discussed on our [Trello Board](https://trello.com/alchemycms). *PLEASE* don't use the Github issues for new features.
100+
* For Q&A and general usage, please use the [Slack](https://slackin.alchemy-cms.com)
102101

103102
Resources
104103
---------
105104

106-
* Homepage: <http://alchemy-cms.com>
107-
* Live-Demo: <https://demo.alchemy-cms.com> (user: demo, password: demo123)
108-
* API Documentation: <http://rubydoc.info/github/AlchemyCMS/alchemy-devise>
105+
* Homepage: <https://alchemy-cms.com>
106+
* Live-Demo: <https://alchemy-demo.herokuapp.com> (user: demo, password: demo123)
107+
* API Documentation: <https://www.rubydoc.info/github/AlchemyCMS/alchemy-devise>
109108
* Issue-Tracker: <https://github.com/AlchemyCMS/alchemy-devise/issues>
110109
* Sourcecode: <https://github.com/AlchemyCMS/alchemy-devise>
111-
* User Group: <http://groups.google.com/group/alchemy-cms>
112-
* IRC Channel: #alchemy_cms on irc.freenode.net
113-
* Discussion Board: <https://trello.com/alchemycms>
110+
* Slack: <https://slackin.alchemy-cms.com>
114111

115112
License
116113
-------

0 commit comments

Comments
 (0)