https://github.com/spaceninja/writing-progress

A web component for authors to track progress towards a word count goal.
https://github.com/spaceninja/writing-progress

Last synced: 2 days ago
JSON representation

A web component for authors to track progress towards a word count goal.

• Host: GitHub
• URL: https://github.com/spaceninja/writing-progress
• Owner: spaceninja
• License: mit
• Created: 2024-03-25T20:26:06.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-04-12T04:02:41.000Z (7 months ago)
• Last Synced: 2024-10-31T17:58:52.913Z (8 days ago)
• Language: HTML
• Size: 4.88 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# writing-progress

[![NPM version](http://img.shields.io/npm/v/@spaceninja/writing-progress.svg)](https://www.npmjs.org/package/@spaceninja/writing-progress)

A web component for authors to track progress towards a word count goal.

- [Demo](https://writing-progress.netlify.app/)

## How Does It Work?

Add the `` element to your page with a `word-count` attribute, and it will calculate the progress towards your goal.

## Installation

```shell

npm install @spaceninja/writing-progress

```

## Usage

```html

```

### Attributes

You can configure the component by setting any of the following attributes on the `` element.

| attribute    | default value             |

| ------------ | ------------------------- |

| `word-count` | none                      |

| `goal`       | `100000`                  |

| `round`      | none                      |

| `start-date` | first day of current year |

| `end-date`   | last day of current year  |