Skip to content

Commit e475c84

Browse files
Update post installation instructions and README
Issues ------ - Closes #37
1 parent 75a1f12 commit e475c84

File tree

2 files changed

+42
-14
lines changed

2 files changed

+42
-14
lines changed

README.md

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
# RailsMvpAuthentication
2-
Short description and motivation.
1+
# 🔐 Rails MVP Authentication
32

4-
## Usage
5-
How to use my plugin.
3+
An authentication generator for Rails 7. Based on the [step-by-step guide on how to build your own authentication system in Rails from scratch](https://github.com/stevepolitodesign/rails-authentication-from-scratch).
4+
5+
## 🚀 Installation
66

7-
## Installation
87
Add this line to your application's Gemfile:
98

109
```ruby
@@ -13,16 +12,39 @@ gem "rails_mvp_authentication"
1312

1413
And then execute:
1514
```bash
16-
$ bundle
15+
bundle
1716
```
1817

1918
Or install it yourself as:
2019
```bash
21-
$ gem install rails_mvp_authentication
20+
gem install rails_mvp_authentication
21+
```
22+
23+
Then run the installation command:
24+
```bash
25+
rails g rails_mvp_authentication:install
26+
```
27+
28+
Once installed make follow these steps:
29+
30+
1. Run `bundle install` to install [bcrypt](https://rubygems.org/gems/bcrypt/)
31+
2. Run `rails db:migrate` to add the `users` and `active_sessions` tables
32+
3. Add a root path in `config/routes.rb`
33+
4. Ensure you have flash messages in `app/views/layouts/application.html.erb`
34+
35+
```html+erb
36+
<p class="notice"><%= notice %></p>
37+
<p class="alert"><%= alert %></p>
2238
```
2339

24-
## Contributing
25-
Contribution directions go here.
40+
## 🙏 Contributing
41+
42+
If you'd like to open a PR please make sure the following things pass:
43+
44+
```ruby
45+
bin/rails test
46+
bundle exec standardrb
47+
```
48+
## 📜 License
2649

27-
## License
28-
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
50+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

lib/generators/rails_mvp_authentication/templates/README

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
Next steps 👇
44

5-
🏗 Run bundle install
6-
💿 Run rails db:migrate
7-
🔗 Add a root path in config/routes.rb
5+
1️⃣ Run bundle install
6+
2️⃣ Run rails db:migrate
7+
3️⃣ Add a root path in config/routes.rb
8+
4️⃣ Ensure you have flash messages in app/views/layouts/application.html.erb.
9+
10+
<p class="notice"><%= notice %></p>
11+
<p class="alert"><%= alert %></p>
12+
13+
=========================================

0 commit comments

Comments
 (0)