Skip to content

Commit 5107e9d

Browse files
author
alexlee-dev
committed
📝 README
1 parent 0036a78 commit 5107e9d

2 files changed

Lines changed: 49 additions & 0 deletions

File tree

src/init.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,10 @@ export const copyTemplateFiles = async (
112112
path.join(__dirname, "template/index.js"),
113113
path.join(root, "/index.js")
114114
);
115+
await fs.copy(
116+
path.join(__dirname, "template/README.md"),
117+
path.join(root, "/README.md")
118+
);
115119
spinner.succeed("Template files copied successfully");
116120
} catch (error) {
117121
spinner.fail(error);

src/template/README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<p align="center">
2+
<a href="" rel="noopener">
3+
<img width=256px height=256px src="https://svgshare.com/i/LWJ.svg" alt="Project logo"></a>
4+
</p>
5+
6+
<h3 align="center">APP NAME</h3>
7+
8+
---
9+
10+
<p align="center"> This application was bootstrapped with <b>create-cli-application</b>
11+
<br>
12+
</p>
13+
14+
## 📝 Table of Contents
15+
16+
- [Getting Started](#getting_started)
17+
- [Built Using](#built_using)
18+
- [Authors](#authors)
19+
20+
## 🏁 Getting Started <a name = "getting_started"></a>
21+
22+
### Creating a Build
23+
24+
`npm run build`
25+
26+
### Starting Program
27+
28+
`npm start`
29+
30+
### Linking Program for use outside of project
31+
32+
`npm link`
33+
34+
## ⛏️ Built Using <a name = "built_using"></a>
35+
36+
- [chalk](https://github.com/chalk/chalk) - Terminal string styling done right.
37+
- [clear](https://github.com/bahamas10/node-clear) - Clear the terminal screen if possible.
38+
- [configstore](https://github.com/yeoman/configstore) - Easily load and persist config without having to think about where and how.
39+
- [inquirer](https://github.com/SBoudrias/Inquirer.js) - A collection of common interactive command line user interfaces.
40+
- [pickitt](https://pickitt.netlify.com/) - When you need a computer to just pick it, reach for Pickitt!
41+
- [TypeScript](https://www.typescriptlang.org/) - A typed superset of JavaScript that compiles to plain JavaScript.
42+
43+
## ✍️ Authors <a name = "authors"></a>
44+
45+
- [Alex Lee](https://github.com/alexlee-dev) - Application Developer

0 commit comments

Comments
 (0)