beadme 0.0.1 → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/config/messages.yml +9 -0
- data/config/questions.yml +43 -0
- data/lib/beadme.rb +1 -1
- data/templates/microverse.md.erb +176 -0
- metadata +4 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: eb0132355faf4ab1184134f67e3b76328a3302a8a04b56f3d354a8dd698e698a
|
|
4
|
+
data.tar.gz: aa1655edb2638566c1b450157f43eb25163225d4ba25b78b96a7ea1f52522420
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7010da775a758399330e92e6e9fbec4fed6d0e95ad48443baae3dd877efad3b9b97e8aa190925fbb162a1d27e7249802ae65846408f56a18ca53b8f8bf33905d
|
|
7
|
+
data.tar.gz: 9cb5d6d660a62a6949a4f62c4567d23126c701353729005295d42b9bd550d77652f448f8ff09cc0ee0fe6c36b4d0be02b0423acc6796a938521a21565b4adbc7
|
data/config/messages.yml
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
welcome: |
|
|
2
|
+
Welcome to the README builder!
|
|
3
|
+
Please answer the following questions to generate your README file.
|
|
4
|
+
You can use Markdown formatting in your answers.
|
|
5
|
+
|
|
6
|
+
Use -h or --help to see the available options.
|
|
7
|
+
_______________________________________________________
|
|
8
|
+
|
|
9
|
+
about: beadme - A CLI tool to create a README.md for your project
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
name: "What is your project name?"
|
|
2
|
+
description: "What is your project description?"
|
|
3
|
+
client_stack: |
|
|
4
|
+
What are the technologies used in your project for the client?
|
|
5
|
+
e.g. React, Redux, Vue (separate with commas)
|
|
6
|
+
server_stack: |
|
|
7
|
+
What are the technologies used in your project for the server?
|
|
8
|
+
e.g. Node, Express, Ruby on Rails (separate with commas)
|
|
9
|
+
database_stack: |
|
|
10
|
+
What are the technologies used in your project for the database?
|
|
11
|
+
e.g. PostgreSQL, MongoDB, MySQL (separate with commas)
|
|
12
|
+
key_features: |
|
|
13
|
+
Describe key features of the application.
|
|
14
|
+
e.g. Realtime updates, Live Chat, etc. (separate with commas)
|
|
15
|
+
live_demo_link: "What is the link to the live demo?"
|
|
16
|
+
requirements: |
|
|
17
|
+
What are the requirements to run the project?
|
|
18
|
+
e.g. Node, Ruby, etc. (separate with commas)
|
|
19
|
+
setup_instructions: |
|
|
20
|
+
How do you set up the project?
|
|
21
|
+
e.g. Clone the repo, install dependencies, etc.
|
|
22
|
+
install_command: |
|
|
23
|
+
What is the command to install the project?
|
|
24
|
+
e.g. npm install, bundle install, etc.
|
|
25
|
+
run_command: |
|
|
26
|
+
What is the command to run the project?
|
|
27
|
+
e.g. npm start, bundle exec rails s, etc.
|
|
28
|
+
test_command: |
|
|
29
|
+
What is the command to test the project?
|
|
30
|
+
e.g. npm test, bundle exec rspec, etc.
|
|
31
|
+
deployment_instructions: |
|
|
32
|
+
How do you deploy this project?
|
|
33
|
+
e.g. Run the build script, etc.
|
|
34
|
+
future_features: |
|
|
35
|
+
Describe features you will add to the project in the future.
|
|
36
|
+
e.g. Payment gateway, etc. (separate with commas)
|
|
37
|
+
acknowledgements: "Who helped you build this project? (Acknowledgements)"
|
|
38
|
+
faq: "What are the frequently asked questions about this project?"
|
|
39
|
+
license: "What is the license for this project?"
|
|
40
|
+
author_name: "What is your name?"
|
|
41
|
+
author_github: "What is your GitHub username?"
|
|
42
|
+
author_twitter: "What is your Twitter username?"
|
|
43
|
+
author_linkedin: "What is your LinkedIn username?"
|
data/lib/beadme.rb
CHANGED
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
<a name="readme-top"></a>
|
|
2
|
+
|
|
3
|
+
<div align="center">
|
|
4
|
+
<h3><b><%= data[:name] %></b></h3>
|
|
5
|
+
</div>
|
|
6
|
+
|
|
7
|
+
# 📗 Table of Contents
|
|
8
|
+
|
|
9
|
+
- [📖 About the Project](#about-project)
|
|
10
|
+
- [🛠 Built With](#built-with)
|
|
11
|
+
- [Tech Stack](#tech-stack)
|
|
12
|
+
- [Key Features](#key-features)
|
|
13
|
+
- [🚀 Live Demo](#live-demo)
|
|
14
|
+
- [💻 Getting Started](#getting-started)
|
|
15
|
+
- [Setup](#setup)
|
|
16
|
+
- [Prerequisites](#prerequisites)
|
|
17
|
+
- [Install](#install)
|
|
18
|
+
- [Usage](#usage)
|
|
19
|
+
- [Run tests](#run-tests)
|
|
20
|
+
- [Deployment](#triangular_flag_on_post-deployment)
|
|
21
|
+
- [👥 Authors](#authors)
|
|
22
|
+
- [🔭 Future Features](#future-features)
|
|
23
|
+
- [🤝 Contributing](#contributing)
|
|
24
|
+
- [⭐️ Show your support](#support)
|
|
25
|
+
- [🙏 Acknowledgements](#acknowledgements)
|
|
26
|
+
- [❓ FAQ (OPTIONAL)](#faq)
|
|
27
|
+
- [📝 License](#license)
|
|
28
|
+
|
|
29
|
+
# 📖 <%= data[:name] %> <a name="about-project"></a>
|
|
30
|
+
|
|
31
|
+
<%= data[:description] %>
|
|
32
|
+
|
|
33
|
+
## 🛠 Built With <a name="built-with"></a>
|
|
34
|
+
|
|
35
|
+
### Tech Stack <a name="tech-stack"></a>
|
|
36
|
+
|
|
37
|
+
<% stacks = data.select { |k| k.to_s.include?('stack') } %>
|
|
38
|
+
<% stacks.each do |key, value| %>
|
|
39
|
+
<% if value.length > 0 %>
|
|
40
|
+
<details>
|
|
41
|
+
<summary><%= key.to_s.split('_').first.capitalize %></summary>
|
|
42
|
+
<ul><% value.each do |tech| %><li><%= tech %></li><% end %></ul>
|
|
43
|
+
</details>
|
|
44
|
+
<% end %>
|
|
45
|
+
<% end %>
|
|
46
|
+
|
|
47
|
+
### Key Features <a name="key-features"></a>
|
|
48
|
+
|
|
49
|
+
<% if data[:key_features].length == 0 %>
|
|
50
|
+
- **No key features**
|
|
51
|
+
<% elsif data[:key_features].length > 0 %>
|
|
52
|
+
<% data[:key_features].each do |feature| %>
|
|
53
|
+
- **<%= feature %>**
|
|
54
|
+
<% end %>
|
|
55
|
+
<% end %>
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
59
|
+
|
|
60
|
+
## 🚀 Live Demo <a name="live-demo"></a>
|
|
61
|
+
|
|
62
|
+
<% if data[:live_demo_link].empty? %>
|
|
63
|
+
- **Live demo not available at this time**
|
|
64
|
+
<% else %>
|
|
65
|
+
- **[Live Demo](<%= data[:live_demo_link] %>)**
|
|
66
|
+
<% end %>
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
## 💻 Getting Started <a name="getting-started"></a>
|
|
73
|
+
|
|
74
|
+
To get a local copy up and running, follow these steps.
|
|
75
|
+
|
|
76
|
+
### Prerequisites
|
|
77
|
+
|
|
78
|
+
In order to run this project you need: <%= data[:requirements] %>
|
|
79
|
+
|
|
80
|
+
<% if !data[:setup_instructions].empty? %>
|
|
81
|
+
### Setup
|
|
82
|
+
<%= data[:setup_instructions] %>
|
|
83
|
+
<% end %>
|
|
84
|
+
|
|
85
|
+
<% if !data[:install_command].empty? %>
|
|
86
|
+
### Install
|
|
87
|
+
|
|
88
|
+
Install this project with:
|
|
89
|
+
```sh
|
|
90
|
+
<%= data[:install_command] %>
|
|
91
|
+
```
|
|
92
|
+
<% end %>
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<% if !data[:run_command].empty? %>
|
|
96
|
+
### Usage
|
|
97
|
+
|
|
98
|
+
To run the project, execute the following command:
|
|
99
|
+
```sh
|
|
100
|
+
<%= data[:run_command] %>
|
|
101
|
+
```
|
|
102
|
+
<% end %>
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
<% if !data[:test_command].empty? %>
|
|
106
|
+
### Run tests
|
|
107
|
+
|
|
108
|
+
To run tests, run the following command:
|
|
109
|
+
```sh
|
|
110
|
+
<%= data[:test_command] %>
|
|
111
|
+
```
|
|
112
|
+
<% end %>
|
|
113
|
+
|
|
114
|
+
<% if !data[:deployment_instructions].empty? %>
|
|
115
|
+
### Deployment
|
|
116
|
+
|
|
117
|
+
<%= data[:deployment_instructions] %>
|
|
118
|
+
<% end %>
|
|
119
|
+
|
|
120
|
+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
121
|
+
|
|
122
|
+
## 👥 Authors <a name="authors"></a>
|
|
123
|
+
|
|
124
|
+
**<%= data[:author_name] %>**
|
|
125
|
+
|
|
126
|
+
<% if !data[:author_github].empty? %> - Github: [@<%= data[:author_github] %>](https://github.com/<%= data[:author_github] %>) <% end %>
|
|
127
|
+
<% if !data[:author_twitter].empty? %> - Twitter: [@<%= data[:author_twitter] %>](https://twitter.com/<%= data[:author_twitter] %>) <% end %>
|
|
128
|
+
<% if !data[:author_linkedin].empty? %> - LinkedIn: [@<%= data[:author_linkedin] %>](https://linkedin.com/in/<%= data[:author_linkedin] %>) <% end %>
|
|
129
|
+
|
|
130
|
+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
131
|
+
|
|
132
|
+
## 🔭 Future Features <a name="future-features"></a>
|
|
133
|
+
|
|
134
|
+
<% if data[:future_features].length == 0 %>
|
|
135
|
+
- More features coming soon!
|
|
136
|
+
<% elsif data[:future_features].length > 0 %>
|
|
137
|
+
<% data[:future_features].each do |feature| %>
|
|
138
|
+
- [ ] **<%= feature %>**
|
|
139
|
+
<% end %>
|
|
140
|
+
<% end %>
|
|
141
|
+
|
|
142
|
+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
143
|
+
|
|
144
|
+
## 🤝 Contributing <a name="contributing"></a>
|
|
145
|
+
|
|
146
|
+
Contributions, issues, and feature requests are welcome!
|
|
147
|
+
|
|
148
|
+
Feel free to check the [issues page](../../issues/).
|
|
149
|
+
|
|
150
|
+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
151
|
+
|
|
152
|
+
## ⭐️ Show your support <a name="support"></a>
|
|
153
|
+
|
|
154
|
+
If you like this project or find it useful, please consider giving it a ⭐️. Thanks!
|
|
155
|
+
|
|
156
|
+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
157
|
+
|
|
158
|
+
## 🙏 Acknowledgments <a name="acknowledgements"></a>
|
|
159
|
+
|
|
160
|
+
<%= data[:acknowledgements] %>
|
|
161
|
+
|
|
162
|
+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
163
|
+
|
|
164
|
+
<% if !data[:faq].empty? %>
|
|
165
|
+
## ❓ FAQ <a name="faq"></a>
|
|
166
|
+
<%= data[:faq] %>
|
|
167
|
+
<% end %>
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
171
|
+
|
|
172
|
+
## 📝 License <a name="license"></a>
|
|
173
|
+
|
|
174
|
+
This project is [<%= data[:license] %>](./LICENSE) licensed.
|
|
175
|
+
|
|
176
|
+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: beadme
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0
|
|
4
|
+
version: 0.1.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Wai Yan Phyo
|
|
@@ -20,9 +20,12 @@ files:
|
|
|
20
20
|
- LICENSE
|
|
21
21
|
- README.markdown
|
|
22
22
|
- bin/beadme
|
|
23
|
+
- config/messages.yml
|
|
24
|
+
- config/questions.yml
|
|
23
25
|
- lib/beadme.rb
|
|
24
26
|
- lib/beadme/runner.rb
|
|
25
27
|
- lib/beadme/template.rb
|
|
28
|
+
- templates/microverse.md.erb
|
|
26
29
|
homepage: https://rubygems.org/gems/beadme
|
|
27
30
|
licenses:
|
|
28
31
|
- MIT
|