Skip to content

Commit

Permalink
[patch] fix component README
Browse files Browse the repository at this point in the history
  • Loading branch information
jchip committed Aug 10, 2017
1 parent b09d017 commit 7cf6c21
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
4 changes: 2 additions & 2 deletions packages/generator-electrode/component/templates/_readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# <%= projectName %>-component
# <%= projectName %>-component

Welcome to the top level of the repo for React component &lt;%= projectName %>.
Welcome to the top level of the repo for React component <%= projectName %>.

This is designed to be a lerna repo with the following two directories:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# &lt;%= projectName %>
# <%= projectName %>

**COMPONENT DESCRIPTION GOES HERE**

## Demo & Examples

Live demo: [&lt;%= ghUser %>.github.io/&lt;%= packageName %>]\(&lt;http&#x3A;//&lt;%= ghUser %>.github.io/&lt;%= packageName %>/>)
Live demo: [<%= ghUser %>.github.io/<%= packageName %>](http://<%= ghUser %>.github.io/<%= packageName %>/)

To develop and see this component in action, please check the [README](../../README.md) at the top level of this repo for instructions.

Expand All @@ -16,7 +16,7 @@ $ clap check

## Installation

The easiest way to use &lt;%= packageName %> is to install it from NPM and include it in your own React build process.
The easiest way to use <%= packageName %> is to install it from NPM and include it in your own React build process.

```bash
$ npm install <%= packageName %> --save
Expand Down Expand Up @@ -50,4 +50,7 @@ var <%= componentName %> = require('<%= packageName %>');

**PUT LICENSE HERE**

Copyright (c) &lt;%= currentYear %> &lt;%= developerName %>.
Copyright (c) <%= currentYear %> <%= developerName %>.


[Electrode]: https://docs.electrode.io/overview/what-is-electrode.html

0 comments on commit 7cf6c21

Please sign in to comment.