Skip to content

Commit

Permalink
Add jekyllized content to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
sondr3 committed Jun 1, 2016
1 parent 6e5792c commit dd4a89e
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
21 changes: 20 additions & 1 deletion generators/app/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,26 @@ module.exports = generators.Base.extend({
projectName: this.props.projectName,
projectDescription: this.props.projectDescription,
projectURL: this.props.projectURL,
authorName: this.props.authorName
authorName: this.props.authorName,
content: `
#### Settings
In your \`_config.yml\` and \`humans.txt\` you should add your Github and Twitter
profile if you want to.
## Install
If you have cloned this repo or want to reinstall, make sure there's no
\`node_modules\` or \`Gemfile.lock\` folder/file and then run \`npm install\` and
\`bundle install\`.
#### Update
To update: \`npm update generator-jekyllized -g\`, then run \`yo jekyllized:gulp
[--rsync|amazon|pages]\` in this directory. Note that this will overwrite any
local changes, so back it up.
## Github
For more information on how to use your new project, please refer to the [README
on Github](https://github.com/sondr3/generator-jekyllized).
`
}
}, {
local: require.resolve('generator-statisk/generators/readme')
Expand Down
4 changes: 4 additions & 0 deletions test/readme.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ test('README is correct', () => {
[
'# README',
'> This is a great README',
'#### Settings',
'## Install',
'#### Update',
'https://github.com/sondr3/generator-jekyllized',
'[Ola Nordmann](http://hello-world.com)'
].forEach(field => {
assert.fileContent('README.md', field);
Expand Down

0 comments on commit dd4a89e

Please sign in to comment.