Skip to content

Commit dd4a89e

Browse files
committed
Add jekyllized content to the README
1 parent 6e5792c commit dd4a89e

File tree

2 files changed

+24
-1
lines changed

2 files changed

+24
-1
lines changed

generators/app/index.js

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,26 @@ module.exports = generators.Base.extend({
126126
projectName: this.props.projectName,
127127
projectDescription: this.props.projectDescription,
128128
projectURL: this.props.projectURL,
129-
authorName: this.props.authorName
129+
authorName: this.props.authorName,
130+
content: `
131+
#### Settings
132+
In your \`_config.yml\` and \`humans.txt\` you should add your Github and Twitter
133+
profile if you want to.
134+
135+
## Install
136+
If you have cloned this repo or want to reinstall, make sure there's no
137+
\`node_modules\` or \`Gemfile.lock\` folder/file and then run \`npm install\` and
138+
\`bundle install\`.
139+
140+
#### Update
141+
To update: \`npm update generator-jekyllized -g\`, then run \`yo jekyllized:gulp
142+
[--rsync|amazon|pages]\` in this directory. Note that this will overwrite any
143+
local changes, so back it up.
144+
145+
## Github
146+
For more information on how to use your new project, please refer to the [README
147+
on Github](https://github.com/sondr3/generator-jekyllized).
148+
`
130149
}
131150
}, {
132151
local: require.resolve('generator-statisk/generators/readme')

test/readme.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,10 @@ test('README is correct', () => {
2828
[
2929
'# README',
3030
'> This is a great README',
31+
'#### Settings',
32+
'## Install',
33+
'#### Update',
34+
'https://github.com/sondr3/generator-jekyllized',
3135
'[Ola Nordmann](http://hello-world.com)'
3236
].forEach(field => {
3337
assert.fileContent('README.md', field);

0 commit comments

Comments
 (0)