Skip to content

Commit 294ee30

Browse files
committed
Bump version and update README
1 parent 64050d2 commit 294ee30

File tree

2 files changed

+22
-11
lines changed

2 files changed

+22
-11
lines changed

README.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,6 @@ Run `rails-new-app` command and follow the step by step wizard.
1111

1212
It will use the current default Rails version, so you should install the version you want to use, these generators are currently tested with Rails 6.
1313

14-
# Tests:
15-
16-
Run `rake test`.
17-
18-
### Alternative
19-
20-
If, for any reason, the menu navigation does not work, run `rails-new-app navigation=false`.
21-
2214
## Current configurations:
2315
- Database: MySQL / PostgreSQL / SQLite
2416
- Tests:
@@ -61,7 +53,15 @@ If, for any reason, the menu navigation does not work, run `rails-new-app naviga
6153
- type of app: standard/minimal/api
6254
- support other databases like MongoDB that require more config
6355

64-
## Adding more configurations and tools:
56+
## For developers
57+
58+
### Setup:
59+
60+
- Clone the repo
61+
- Run `bundle install`
62+
- You can run the app with `./exe/rails-new-app`
63+
64+
### Adding more configurations and tools:
6565

6666
1. Add a new step at `lib/rails-new-app/steps` (or modify an existing one)
6767
2. Collect step config in the `config` hash
@@ -73,7 +73,7 @@ If, for any reason, the menu navigation does not work, run `rails-new-app naviga
7373

7474
* Steps 5 and 6 are split so we can run `bundle install` once.
7575

76-
## Quick test for developers
76+
### Quick scripted execution:
7777

7878
Since the app uses the STDIN to configure the generator, you can pipe a stream of inputs that a user would do to the command to quickly set all the desired options. For example:
7979

@@ -99,6 +99,10 @@ cat defaults.txt | rails-new-app
9999

100100
This can eventually be used to share complete setups or generate defaults.
101101

102+
### Tests:
103+
104+
Run `rake test` or `COVERAGE=true rake test`.
105+
102106
## Changelogs
103107

104108
### 0.0.1
@@ -113,3 +117,10 @@ Added navigation between menus.
113117
- Add a git initial commit
114118
- Added new tools: Faker, pagination gems
115119
- Bug fixing
120+
121+
### 0.1
122+
- Refactor screens (ex steps) handling
123+
- Refactor user input handling to allow easier testing
124+
- Added tests for multiple screens
125+
- Bug fixing (Pagy config, incorrect indexing)
126+
- Added SimpleCov and easier dev setup

lib/rails-new-app/version.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
module RailsNewApp
2-
VERSION = Gem::Version.new("0.0.3")
2+
VERSION = Gem::Version.new("0.1.0")
33
end

0 commit comments

Comments
 (0)