Merge pull request #2 from robertoachar/develop

v1.0.1

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## v1.0.1
+
+### Template Updates
+
+- **fix**: footer content
+- **fix**: fix author
+
+### Generator Updates
+
+- **docs**: : update README
+
 ## v1.0.0
 
 - Initial release

README.md

@@ -1,6 +1,6 @@
 # generator-workshop
 
-Generated by [OSS Project Generator](http://bit.ly/generator-oss-project).
+> Yeoman generator for my workshops.
 
 [![Travis Status][travis-badge]][travis-url]
 [![AppVeyor Status][appveyor-badge]][appveyor-url]
@@ -9,32 +9,118 @@ Generated by [OSS Project Generator](http://bit.ly/generator-oss-project).
 [![NPM Version][npm-badge]][npm-url]
 [![License][license-badge]][license-url]
 
-> Yeoman generator for my workshops.
+This generator provides the following features:
+
+- **VuePress** as a static site generator.
+- **docs** folder as a starter point to build your workshop.
+- **PWA** ready.
+- **CC-BY-NC-SA-4.0 License** to help protect your content.
+- and more...
+
+## Project files
+
+```text
+.
+|--- docs
+|    |--- .vuepress
+|    |    |--- public
+|    |    |    |--- android-chrome-192x192.png
+|    |    |    |--- android-chrome-512x512.png
+|    |    |    |--- apple-touch-icon.png
+|    |    |    |--- browserconfig.xml
+|    |    |    |--- favicon-16x16.png
+|    |    |    |--- favicon-32x32.png
+|    |    |    |--- favicon.ico
+|    |    |    |--- mstile-150x150.png
+|    |    |    |--- safari-pinned-tab.svg
+|    |    |    |--- site.webmanifest
+|    |    |--- config.js
+|    |    |--- head.js
+|    |    |--- override.styl
+|    |    |--- style.styl
+|    |    workshop
+|    |    |--- README.md
+|    |--- README.md
+|--- .editorconfig
+|--- .eslintignore
+|--- .eslintrc.json
+|--- .gitattributes
+|--- .gitignore
+|--- .npmrc
+|--- .prettierrc
+|--- CHANGELOG.md
+|--- LICENSE
+|--- package.json
+|--- README.md
+```
+
+## Installation
+
+- Install Yeoman
+
+```bash
+$ npm install -g yo
+```
+
+- Install Generator
+
+```bash
+$ npm install -g @robertoachar/generator-workshop
+```
+
+## Usage
+
+- Creating a workshop
+
+```bash
+# Create a directory for your workshop
+$ mkdir awesome-workshop
+
+# Change into directory
+$ cd awesome-workshop
+
+# Generate a workshop
+$ yo @robertoachar/workshop
+```
+
+- Running workshop
+
+| Action                 | Usage           |
+| ---------------------- | --------------- |
+| Start development mode | `npm start`     |
+| Lint code              | `npm run lint`  |
+| Build for production   | `npm run build` |
 
 ## Development
 
-- Clone
+### Prerequisites
+
+- Install [Node.js](https://nodejs.org)
+- Install [npm](https://www.npmjs.com/)
+- Install Yeoman CLI
 
 ```bash
-$ git clone https://github.com/robertoachar/generator-workshop.git
+$ npm install -g yo
 ```
 
-- Install dependencies
+### Clone the repo
 
 ```bash
-$ npm install
+$ git clone https://github.com/robertoachar/generator-workshop.git
 ```
 
-- Run scripts
+### Run generator
 
-| Action                                | Usage               |
-| ------------------------------------- | ------------------- |
-| Start development mode                | `npm start`         |
-| Lint code                             | `npm run lint`      |
-| Run unit tests                        | `npm run jest`      |
-| Run code coverage                     | `npm run coverage`  |
-| Run lint + tests                      | `npm test`          |
-| Send coverage results to Coveralls.io | `npm run coveralls` |
+```bash
+# Change into directory
+$ cd generator-workshop
+
+# Link generator
+$ npm link
+
+# Run generator
+$ yo @robertoachar/workshop
+```
 
 ## Author
 
@@ -52,7 +138,7 @@ $ npm install
 [circleci-url]: https://circleci.com/gh/robertoachar/generator-workshop
 [coveralls-badge]: https://coveralls.io/repos/github/robertoachar/generator-workshop/badge.svg?branch=master
 [coveralls-url]: https://coveralls.io/github/robertoachar/generator-workshop?branch=master
-[npm-badge]: https://img.shields.io/npm/v/generator-workshop.svg
-[npm-url]: https://www.npmjs.com/package/generator-workshop
+[npm-badge]: https://img.shields.io/npm/v/@robertoachar/generator-workshop.svg
+[npm-url]: https://www.npmjs.com/package/@robertoachar/generator-workshop
 [license-badge]: https://img.shields.io/github/license/robertoachar/generator-workshop.svg
 [license-url]: https://opensource.org/licenses/MIT

generators/app/templates/README.md

@@ -28,7 +28,7 @@ $ npm install
 
 # Author
 
-[Roberto Achar](https://twitter.com/robertoachar)
+[<%= name %>](https://twitter.com/<%= username %>)
 
 # License
 

generators/app/templates/docs/README.md

@@ -2,5 +2,5 @@
 home: true
 actionText: Iniciar treinamento →
 actionLink: /workshop/
-footer: CC-BY-NC-SA-4.0 © 2018 Roberto Achar
+footer: CC-BY-NC-SA-4.0 © <%= year %> <%= name %>
 ---

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@robertoachar/generator-workshop",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Yeoman generator for my workshops.",
   "author": "Roberto Achar <robertoachar@gmail.com>",
   "homepage": "https://github.com/robertoachar/generator-workshop#readme",