generator-reveal - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

app/index.js

@@ -60,2 +60,3 @@ 'use strict';
   this.template('_config.json', 'config.json');
+  this.copy('list.json', 'slides/list.json');
 };
@@ -62,0 +63,0 @@

app/templates/_bower.json

@@ -5,4 +5,6 @@ {
   "dependencies": {
-    "reveal.js": "~2.4"
+    "reveal.js": "~2.4",
+    "handlebars": "~1.0.0",
+    "jquery": "~1.10"
   }
 }

package.json

 {
   "name": "generator-reveal",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "A Reveal.js generator for Yeoman",
@@ -5,0 +5,0 @@ "keywords": [

README.md

@@ -5,18 +5,53 @@ # Generator-reveal
 
-## Getting started
-- Make sure you have [yo](https://github.com/yeoman/yo) installed
-- clone this repo
+## Usage
+
+Install `generator-reveal`:
 ```
-git clone https://github.com/slara/generator-reveal
-cd generator-reveal
+npm install generator-reveal
 ```
-- link the generator to npm: `npm link`
-- Go to your new project directory
-- Run: `yo reveal`
 
-## Subgenerators:
+Make a new directory, and `cd` into it:
+```
+mkdir my-new-project && cd $_
+```
 
-- reveal:slide
+Run `yo reveal`:
+```
+yo reveal
+```
 
+After all files are created you can view your slides with `grunt`
+
+```bash
+grunt server
+```
+
+## Generators
+
+Available generators:
+
+* [reveal:slide](#slide)
+
+### Slide
+Generates a Slide Markdown file. 
+
+Example:
+```bash
+yo reveal:slide "Slide Title"
+```
+
+Produces `slides/slide-title.md`:
+```markdown
+## Slide Title
+
+This is a new slide
+```
+
+After you fill your slide with content, you need to add the slide filename to your `slides/list.json` file, e.g.
+
+```json
+["index.md", "slide-title.md"]
+```
+
 ## License
 [MIT License](http://en.wikipedia.org/wiki/MIT_License)

slide/templates/slide.md

 ##  <%= name %>
 
-This is a new slide
+This is a new slide

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

13269

increased by7.84%

Number of package files

25

increased by4.17%

Lines of code

182

increased by2.25%

Number of lines in readme file

57

increased by159.09%

No dependency changes