├── README.md
└── screenshots
└── 1.jpg
/README.md:
--------------------------------------------------------------------------------
1 |
2 |
3 | [Project's Logo]
4 |
5 | [Project's name]
6 |
7 |
8 |
9 | [Project's description]
10 |
11 |
12 | [Project's badges]
13 |
14 |
15 |
16 | About •
17 | Key Features •
18 | Getting Started •
19 | FAQ •
20 | Roadmap •
21 | Support •
22 | License
23 |
24 |
25 | 
26 |
27 | ## About
28 |
29 | Simple overview of use/purpose.
30 |
31 | ## Key Features
32 |
33 | - Feature 1
34 | - Feature 2
35 | - Feature 2.1
36 | - Feature 2.2
37 | - Feature 3
38 |
39 | ## Getting Started
40 |
41 | This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
42 |
43 | ### Prerequisites
44 |
45 | This is an example of how to list things you need to use the software and how to install them.
46 |
47 | - npm
48 |
49 | ### Installing and Running
50 |
51 | Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.
52 |
53 | ```bash
54 | # Clone this repository
55 | $ git clone https://github.com/[your-github-user]/[your-repository-name]
56 |
57 | # Go into the repository
58 | $ cd [your-repository-name]
59 | ```
60 |
61 | ## FAQ
62 |
63 | ### Is it any good?
64 |
65 | [yes.](https://news.ycombinator.com/item?id=3067434)
66 |
67 | ## Definitions
68 |
69 | - This are constraints you give to your project
70 | - Here's another constraint: use this README!
71 |
72 | ## Roadmap
73 |
74 | - [x] Add this README.
75 | - [ ] Finish the unicorn project.
76 |
77 | ## Emailware
78 |
79 | [Project's name] is an [emailware](https://en.wiktionary.org/wiki/emailware). Meaning, if you liked using this app or it has helped you in any way, I'd like you send me an email at about anything you'd want to say about this software. I'd really appreciate it!
80 |
81 | ## Contributing
82 |
83 | If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
84 | Don't forget to give the project a star! Thanks again!
85 |
86 | 1. Fork the project
87 | 2. Clone it open the repository in command line
88 | 3. Create your feature branch (`git checkout -b feature/amazing-feature`)
89 | 4. Commit your changes (`git commit -m 'Add some amazing feature'`)
90 | 5. Push to the branch (`git push origin feature/amazing-feature`)
91 | 6. Open a pull request from your feature branch from your repository into this repository main branch, and provide a description of your changes
92 |
93 | ## Support
94 |
95 | You can also support us by:
96 |
97 |
98 | 
99 |
100 | 
101 |
102 |
103 |
104 | ## License
105 |
106 | Your license here.
107 |
108 | ## Acknowledgments
109 |
110 | Inspiration, code snippets, etc.
111 |
112 | - [Markdownify's README](https://github.com/amitmerchant1990/electron-markdownify#readme)
113 |
114 | ## You may also like...
115 |
116 | List of apps or libs that do similar stuff as your project.
117 |
118 | - [Best-README-Template](https://github.com/othneildrew/Best-README-Template)
119 | - [Simple README.md template](https://gist.github.com/DomPizzie/7a5ff55ffa9081f2de27c315f5018afc)
120 |
121 | ---
122 |
123 | > [hidek.xyz](https://hidek.xyz) ·
124 | > GitHub [@abehidek](https://github.com/abehidek) ·
125 | > Twitter [@guilhermehabe](https://twitter.com/guilhermehabe)
126 |
--------------------------------------------------------------------------------
/screenshots/1.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/abehidek/readme/b3b174afc33a7755999714e50ee281db3b3c3a81/screenshots/1.jpg
--------------------------------------------------------------------------------