Skip to content

Commit 8ee5f6d

Browse files
authored
Provide helpful instructions in new app README (#273)
1 parent cc1ebe0 commit 8ee5f6d

File tree

2 files changed

+56
-0
lines changed

2 files changed

+56
-0
lines changed
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,15 @@
11
# <%= camelized_app_name %>
2+
3+
Welcome to your Hanami app!
4+
5+
## Getting Started
6+
7+
- Run the server with `bin/dev`
8+
- View the app at [http://localhost:2300](http://localhost:2300)
9+
- Run the tests with `bundle exec rake`
10+
11+
## Useful Links
12+
13+
- [Hanami Home](http://hanamirb.org)
14+
- [Hanami Guides](https://guides.hanamirb.org/)
15+
- [Hanami API Doc](https://gemdocs.org/gems/hanami/latest)

spec/unit/hanami/cli/commands/gem/new_spec.rb

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,20 @@
126126
# README.md
127127
readme = <<~EXPECTED
128128
# #{inflector.camelize(app)}
129+
130+
Welcome to your Hanami app!
131+
132+
## Getting Started
133+
134+
- Run the server with `bin/dev`
135+
- View the app at [http://localhost:2300](http://localhost:2300)
136+
- Run the tests with `bundle exec rake`
137+
138+
## Useful Links
139+
140+
- [Hanami Home](http://hanamirb.org)
141+
- [Hanami Guides](https://guides.hanamirb.org/)
142+
- [Hanami API Doc](https://gemdocs.org/gems/hanami/latest)
129143
EXPECTED
130144
expect(fs.read("README.md")).to eq(readme)
131145
expect(output).to include("Created README.md")
@@ -590,6 +604,20 @@ class Operation < Dry::Operation
590604
# README.md
591605
readme = <<~EXPECTED
592606
# #{inflector.camelize(app)}
607+
608+
Welcome to your Hanami app!
609+
610+
## Getting Started
611+
612+
- Run the server with `bin/dev`
613+
- View the app at [http://localhost:2300](http://localhost:2300)
614+
- Run the tests with `bundle exec rake`
615+
616+
## Useful Links
617+
618+
- [Hanami Home](http://hanamirb.org)
619+
- [Hanami Guides](https://guides.hanamirb.org/)
620+
- [Hanami API Doc](https://gemdocs.org/gems/hanami/latest)
593621
EXPECTED
594622
expect(fs.read("README.md")).to eq(readme)
595623
expect(output).to include("Created README.md")
@@ -1125,6 +1153,20 @@ module Types
11251153
# README.md
11261154
readme = <<~EXPECTED
11271155
# #{inflector.camelize(app)}
1156+
1157+
Welcome to your Hanami app!
1158+
1159+
## Getting Started
1160+
1161+
- Run the server with `bin/dev`
1162+
- View the app at [http://localhost:2300](http://localhost:2300)
1163+
- Run the tests with `bundle exec rake`
1164+
1165+
## Useful Links
1166+
1167+
- [Hanami Home](http://hanamirb.org)
1168+
- [Hanami Guides](https://guides.hanamirb.org/)
1169+
- [Hanami API Doc](https://gemdocs.org/gems/hanami/latest)
11281170
EXPECTED
11291171
expect(fs.read("README.md")).to eq(readme)
11301172

0 commit comments

Comments
 (0)