README.md

Word counting

A very powerful words counter that supports plain text and html.

• Word counting
  • Why this project
  • Installation
  • Basic Usage
  • Contributing
  • Contributors

Why this project

• Support node and browser environment.
• Support html formated text. (Won't count tags)
• Well typed

Installation

# Using npm
npm install --save word-counting

# Using yarn
yarn add word-counting

Basic Usage

Inject the library in your file:

// javascript
var wordsCounter = require('word-counting')

// typescript
import wordsCounter from 'word-counting'

Count the words for plain text:

const mockedText = 'These are some mocked words.'
console.log(wordsCounter(mockedText).wordsCount) // 5

Count the words for html:

const mockedText = '<p>These are some mocked words with html format</p>'
console.log(wordsCounter(mockedText, { isHtml: true }).wordsCount) // 8

Contributing

Feel free to make any improvements or changes. Any changes will be appreciated and I'll add you to the contributors list below. :)

1. Fork it (https://github.com/nerdmax/word-counting/fork)
2. Create your feature branch. (git checkout -b feature/fooBar)
3. Make some changes.
4. State your changes. (git add .)
5. Commit your changes (yarn commit). NOTE: This repo is following the conventional commits, and yarn commit is the easiest way to construct the commit message.
6. Push to the branch. (git push origin feature/fooBar)
7. Create a new Pull Request.

Contributors

Max Liu 💻 📖 🚇 ⚠️

Pepe Sosa 🐛

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!