Merge pull request #5 from alexlee-dev/v0.5.0

📦 v0.5.0

Author: Alex Lee

CHANGELOG.md

@@ -5,6 +5,25 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.5.0] - 2020-05-29
+
+### ❗Update Notifier
+
+### Added
+
+- CONTRIBUTING.md
+- GIF examples
+- Use of `update-notifier` to alert the user to a newer version
+- Added `Additional Features to Be Added` to README
+
+### Changed
+
+### Removed
+
+### Fixed
+
+- `___AUTHOR NAME___` not being overwritten in template during interactive mode
+
 ## [0.4.0] - 2020-05-27
 
 ### ✨ Interactivity

CONTRIBUTING.md

@@ -0,0 +1,36 @@
+# Contributing Guide
+
+- Contributing to **create-cli-application** is fairly easy. This document shows you how to get started.
+
+## Submitting changes
+
+- Fork the repo
+  - <https://github.com/alexlee-dev/create-cli-application/fork>
+- Check out a new branch based and name it to what you intend to do:
+  - Example:
+    ```
+    $ git checkout -b BRANCH_NAME
+    ```
+    If you get an error, you may need to fetch first by using
+    ```
+    $ git remote update && git fetch
+    ```
+  - Use one branch per fix / feature
+- Commit your changes
+  - Please provide a git message that explains what you've done
+  - Please make sure your commits follow the [conventions](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53#file-commit-message-guidelines-md)
+  - Commit to the forked repository
+  - Example:
+    ```
+    $ git commit -am 'Add some fooBar'
+    ```
+- Push to the branch
+  - Example:
+    ```
+    $ git push origin BRANCH_NAME
+    ```
+- Make a pull request
+  - Make sure you send the PR to the <code>fooBar</code> branch
+  - Travis CI is watching you!
+
+If you follow these instructions, your PR will land pretty safely in the main repo!

README.md

@@ -20,6 +20,8 @@
     <br> 
 </p>
 
+![Example of create-cli-application running](https://res.cloudinary.com/alexlee-dev/image/upload/v1590711256/create-cli-application/example.gif)
+
 ## 📝 Table of Contents
 
 - [About](#about)
@@ -56,6 +58,12 @@ By deafault, **create-cli-application** will create your application as a JavaSc
 
 Want support for an additional language? Feel free to open a [new issue](https://github.com/alexlee-dev/create-cli-application/issues/new).
 
+### Interactive Mode
+
+You can choose to use the application in an interactive mode by passing the flag `--interactive`.
+
+![Interactive Mode Example](https://res.cloudinary.com/alexlee-dev/image/upload/v1590763194/create-cli-application/interactive.gif)
+
 ## ⛏️ Built Using <a name = "built_using"></a>
 
 - [@sentry/node](https://sentry.io/welcome/) - Sentry is cross-platform application monitoring, with a focus on error reporting.
@@ -68,12 +76,20 @@ Want support for an additional language? Feel free to open a [new issue](https:/
 - [ora](https://github.com/sindresorhus/ora) - Elegant terminal spinner.
 - [pickitt](https://pickitt.netlify.com/) - When you need a computer to just pick it, reach for Pickitt!
 - [TypeScript](https://www.typescriptlang.org/) - A typed superset of JavaScript that compiles to plain JavaScript.
+- [update-notifier](https://github.com/yeoman/update-notifier) - Update notifications for your CLI app.
 - [validate-npm-package-name](https://github.com/npm/validate-npm-package-name) - Is the given string an acceptable npm package name?
 
 ## ✍️ Authors <a name = "authors"></a>
 
 - [Alex Lee](https://github.com/alexlee-dev) - Application Developer
 
+## 🚀 Additional Features to Be Added
+
+- Compiler Choice
+- Formatter Choice
+- Linter Choice
+- Menu Styling
+
 ## 🎉 Acknowledgements <a name = "acknowledgement"></a>
 
 - Some inspiration from the developers behind [create-react-app](https://github.com/facebook/create-react-app).