File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -16,7 +16,40 @@ module.exports.handler = function handler(options) {
1616 const { stripIndent } = require ( 'common-tags' ) ;
1717 const pkg = require ( '../../package.json' ) ;
1818
19- fs . outputFileSync ( projectName + '/README.md' , `# ${ projectName } \n` , 'utf8' ) ;
19+ fs . outputFileSync (
20+ projectName + '/README.md' ,
21+ stripIndent `
22+ # ${ projectName } \n
23+
24+ A collection of codemod's for ${ projectName } .
25+
26+ ## Usage
27+
28+ To run a specific codemod from this project, you would run the following:
29+
30+ \`\`\`
31+ npx ${ projectName } <TRANSFORM NAME> path/of/files/ or/some**/*glob.js
32+
33+ # or
34+
35+ yarn global add ${ projectName }
36+ ${ projectName } <TRANSFORM NAME> path/of/files/ or/some**/*glob.js
37+ \`\`\`
38+
39+ ## Contributing
40+
41+ ### Installation
42+
43+ * clone the repo
44+ * change into the repo directory
45+ * \`yarn\`
46+
47+ ### Running tests
48+
49+ * \`yarn test\`
50+ ` ,
51+ 'utf8'
52+ ) ;
2053 fs . outputJsonSync (
2154 projectName + '/package.json' ,
2255 {
You can’t perform that action at this time.
0 commit comments