Merge pull request #9 from codefeathers/develop

Minor changes and cleanup of .md files to /docs/

Contributing.MD

@@ -14,18 +14,18 @@ Contributing to a project on Github is pretty straight forward. If this is you'r
 
 - Fork this repo.
 
-And that's it! Read the code available and change the part you don't like! You're change should not break the existing code and should pass the tests. We recommend using VS Code while working on this project.
+And that's it! Read the code available and change the part you don't like! Your change should not break any existing functionality and should work as promised. If you're having trouble with it, mention it. We recommend using VS Code while working on this project.
 
-If you're adding a new functionality, start from the branch master. It would be a better practice to create a new branch and work in there.
+If you're adding a new functionality, start from the branch develop. It would be a better practice to create a new branch and work in there.
 
 When you're done, submit a pull request and for one of the maintainers to check it out. We would let you know if there is any problem or any changes that should be considered.
 
 ### Tests
 
-We haven't written tests yet and you can manually try commands and assure the stability of the code. If you're adding a new test please write documentation for it by creating Tests.MD.
+We haven't written tests yet and you can manually try commands and assure the stability of the code. If you're adding a new test please write documentation for it by creating /docs/Tests.MD.
 
 ### Documentation
 
 Every chunk of code that may be hard to understand has some comments above it. If you write some new code or change some part of the existing code in a way that it would not be functional without changing it's usages, it needs to be documented.
 
-**__Overall, just have fun, and make sure nothing breaks. Thanks!__**
+**__Overall, just have fun, and make sure nothing breaks. Thanks!__**

README.md

@@ -10,7 +10,7 @@
 
 > Current version: `up v.0.2.1 (Alpha)`
 
-> Notes: `up` is now in Alpha! 🎉 [(Changelog)](Changelog.md)\
+> Notes: `up` is now in Alpha! 🎉 [(Changelog)](/docs/Changelog.md)\
 > ⚠️ ❌ `up` is pretty useable so far. If you're testing `up` on a development server, do give us feedback.
 
 **`up`** is a command line application that creates nginx server blocks quickly with a single command.
@@ -43,12 +43,10 @@ Format: `up command <required> [optional]`
 - `up proxy example.com 8081` will create a reverse proxy listening at port 8081.
 - `up kill example.com`
 
-## Contributors, Collaborators, and Guides
+---
 
-Plenty of people gave their time guiding me and shaping this tool.
+<h4 align="center"><a href="/docs/Roadmap.MD">Roadmap</a></h4>
 
-I'd like to thank and give credit to [The Devs Community](https://thedevs.network), who are the primary reason this exists.
+<h4 align="center"><a href="Contributing.MD">Contribution Guidelines</a></h4>
 
-I'd also personally thank the following amazing people for their valuable support and feedback: **Pouria Ezzati, Thomas Rory Gummerson, Omar Khalil, Martin, GingerPlusPlus, Faizan Akram.**
-
-And the following people for their moral support and listening to my constant bickering: **David (The Humanoid), Иброхеем,  Simon 'SitiSchu' Schürrle.**
+<h4 align="center"><a href="/docs/Contributors.md">Contributors, Collaborators, and Guides</a></h4>

Changelog.md → docs/Changelog.md

@@ -1,8 +1,10 @@
 # Changelog / Version history
 
-## `up` v. 0.2.0
+## `up` v. 0.2.1
+
+- Bug fix and patch for `up kill-all` breaking unexpectedly due to undefined default config file.
 
-Changelog:
+## `up` v. 0.2.0
 
 - Under the hood BREAKING changes. Working directories change.
    - `/var/www/` to `/etc/up-serve/static/`
@@ -10,4 +12,4 @@ Changelog:
 - `up static|proxy <domain>` adds the server to `/etc/up-serve/servers.up` list.
 - `up kill <domain>` removes server from `servers.up` list.
 - `up list` lists available servers from /etc/up-serve/servers.up!
-- `up kill-all` destroys all servers and places a `default.conf` in `/etc/nginx/sites-enabled`.
+- `up kill-all` destroys all servers and places a `default.conf` in `/etc/nginx/sites-enabled`.

docs/Contributors.md

@@ -0,0 +1,15 @@
+# Contributors, Collaborators, and Guides
+
+I'd like to thank and give credit to [The Devs Community](https://thedevs.network), who are the primary reason this exists.
+
+Plenty of people gave their time guiding me and shaping this tool. I'd personally thank the following amazing people for their valuable support and feedback:
+
+- Pouria Ezzati (https://github.com/poeti8)
+- Thomas Rory Gummerson (https://github.com/trgwii)
+- Omar Khalil (https://github.com/DonMcCoy)
+- Martin (https://gitlab.com/C0rn3j)
+- GingerPlusPlus (https://github.com/GingerPlusPlus)
+- Faizan Akram (https://github.com/faizanakram99)
+- Chris Watson (https://github.com/watzon)
+
+And many many people who did not directly contribute but managed to keep listening to my crazy ideas (and motivating) towards the beginning of this project.

Roadmap.md → docs/Roadmap.md

@@ -11,16 +11,16 @@ This living document details our plans for `up`. If you would like to request fe
 - [x] MVP - Minimum Viable Product.
   - [x] `up static` and `up proxy` MUST work.
   - [x] `up kill` MUST work.
-- [x]List servers option.
+- [x] List servers option.
   - [x] `up list` MUST provide list of servers running from `/etc/up-serve/servers.up` file.
-- [x] `up static` MUST have an option to specify path to root. Example: `up static example.com ./public`.
+- [ ] `up static` MUST have an option to specify path to root. Example: `up static example.com ./public`.
 - [ ] `up static` and `up proxy` MAY take a Git URL to deploy. Example:
   1. `up static example.com --git https://github.com/h5bp/html5-boilerplate /html`
   2. `up proxy example.com 5000 --git https://github.com/heroku/node-js-sample`
 - [ ] Option for HTTPS.
   - [ ] MUST add a `-s` or `--secure` flag to enable automatic HTTPS config with HTTP/2 enabled by default.
     - [ ] HSTS MAY be enabled with a `-s -h`, `-sh`, `-secure -hsts` or `--secure-hsts` flag. Will warn user to be sure of what they are doing.
-  - [ ] MAY add a `-c` flag to use `certbot` to automatically generate certificates using letsencrypt.
+  - [ ] MAY add a `-c` flag to use `certbot` or `acme.sh` to automatically generate certificates using letsencrypt.
 - [ ] MAY make `up` work on Windows.
 
 Want more features or prioritize something? Raise an [issue!](https://github.com/codefeathers/up-serve/issues)
@@ -30,4 +30,4 @@ Want more features or prioritize something? Raise an [issue!](https://github.com
 - ♦ Create an `up` client to deploy from anywhere
 - ♦ Make `up` an initialization tool that combines `git init`, `npm init`, `vue init`, etc. in a neat package. Examples:
   1. `up new git`
-  2. `up new vue proxy 4000`
+  2. `up new vue proxy 4000`