Skip to content

Tidy README instructions and examples#27

Merged
remarkablemark merged 5 commits intomasterfrom
chore-readme
Sep 28, 2016
Merged

Tidy README instructions and examples#27
remarkablemark merged 5 commits intomasterfrom
chore-readme

Conversation

@remarkablemark
Copy link
Copy Markdown
Owner

@remarkablemark remarkablemark commented Sep 28, 2016

Chore:

  • Update README.md:
    • Reword beginning description
    • Add installation instruction using CDN
    • Update usage examples
    • Update replace options
      • Refactor simple and advanced examples to ES6, JSX, and simplify

Make explanations/examples clearer, trim fat, and add hyperlinks.
Separate the examples into their own code blocks. Rewrite in ES6
syntax for cleanliness and readability.
Make instructions clearer; simplifying examples by removing
unnecessary parts and rewriting them with ES6.
Trim the fat and keep the example super concise and readable.
Refactor example to ES6 and JSX.
@remarkablemark remarkablemark added the documentation Improvements or additions to documentation label Sep 28, 2016
@remarkablemark remarkablemark self-assigned this Sep 28, 2016
@coveralls
Copy link
Copy Markdown

Coverage Status

Coverage remained the same at 97.949% when pulling b89ca5b on chore-readme into 43f46ce on master.

@remarkablemark remarkablemark merged commit c7bfd40 into master Sep 28, 2016
@remarkablemark remarkablemark deleted the chore-readme branch September 28, 2016 03:27
remarkablemark added a commit that referenced this pull request Sep 28, 2016
- Update build (#25):
  - Change filenames in `dist/` to `html-react-parser`
- Create examples (#26):
  - Examples found in the directory `examples/`
  - Add `script-tag.html`, which is an example of loading the
    parser via the CDN
  - Add `requirejs.html`, which is an example of loading the
    parser via Require.js
- Update `README.md` (#27):
  - Reword and tidy description and instructions
  - Update installation with CDN link
  - Refactor and tidy examples using ES6 and JSX
- Update `.npmignore`:
  - Add `webpack.config.js`
  - Add `examples`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants