timered-counter 0.0.9 → 0.1.0

package/README.md

@@ -1,76 +1,51 @@
-# \<timered-counter>
-
-This webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) recommendation.
-
-## Installation
-
-```bash
-npm i timered-counter
-```
-
-## Usage
-
-```html
-<script type="module">
-  import 'timered-counter/timered-counter.js';
-</script>
-
-<timered-counter></timered-counter>
-```
-
-## Linting and formatting
-
-To scan the project for linting and formatting errors, run
-
-```bash
-npm run lint
-```
-
-To automatically fix linting and formatting errors, run
-
-```bash
-npm run format
-```
-
-## Testing with Web Test Runner
-
-To execute a single test run:
-
-```bash
-npm run test
-```
-
-To run the tests in interactive watch mode run:
-
-```bash
-npm run test:watch
-```
-
-## Demoing with Storybook
-
-To run a local instance of Storybook for your component, run
-
-```bash
-npm run storybook
-```
-
-To build a production version of Storybook, run
-
-```bash
-npm run storybook:build
-```
-
-
-## Tooling configs
-
-For most of the tools, the configuration is in the `package.json` to reduce the amount of files in your project.
-
-If you customize the configuration a lot, you can consider moving them to individual files.
-
-## Local Demo with `web-dev-server`
-
-```bash
-npm start
-```
-
-To run a local development server that serves the basic demo located in `demo/index.html`
+# timered-counter
+
+Make the value change more vivid and natural.
+
+![npm](https://img.shields.io/npm/v/timered-counter?style=flat-square)
+![npm](https://img.shields.io/npm/dm/timered-counter?style=flat-square)
+![NPM](https://img.shields.io/npm/l/timered-counter?style=flat-square)
+[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release&style=flat-square)](https://github.com/semantic-release/semantic-release)
+[![Netlify Status](https://api.netlify.com/api/v1/badges/133df312-97ec-411b-816e-52ee0bd49808/deploy-status?style=flat-square)](https://app.netlify.com/sites/timered-counter/deploys)
+
+<table>
+<tr>
+<th colspan="4">Timered Counter</th>
+</tr>
+<tr>
+<td><img src="./demo/images/simple.gif" /></td>
+<td><img src="./demo/images/countdown.gif" /></td>
+<td><img src="./demo/images/string.gif" /></td>
+<td><img src="./demo/images/color.gif" /></td>
+</tr>
+<tr>
+<td><a href="https://timered-counter.netlify.app/guide/examples/simple-usage.html#number"><strong>Simple</strong></a></td>
+<td><a href="https://timered-counter.netlify.app/guide/examples/simple-usage.html#datetime-duration"><strong>Countdown</strong></a></td>
+<td><a href="https://timered-counter.netlify.app/guide/examples/simple-usage.html#string"><strong>String</strong></a></td>
+<td><a href="https://timered-counter.netlify.app/guide/examples/styled-usage.html#color"><strong>Colorful</strong></a></td>
+</tr>
+<tr>
+<td><img src="./demo/images/locale.gif" /></td>
+<td><img src="./demo/images/delay.gif" /></td>
+<td><img src="./demo/images/easing.gif" /></td>
+</tr>
+<tr>
+<td><a href="https://timered-counter.netlify.app/guide/examples/locale-usage.html#locale-datetime-duration"><strong>Locale</strong></a></td>
+<td><a href="https://timered-counter.netlify.app/guide/examples/animated-usage.html#delay"><strong>Delay</strong></a></td>
+<td><a href="https://timered-counter.netlify.app/guide/examples/animated-usage.html#easing"><strong>Easing</strong></a></td>
+</tr>
+</table>
+
+## Documentation
+
+- [Online Documentation](https://timered-counter.netlify.app/)
+
+## Thanks
+
+![JetBrains Logo (Main) logo](https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg)
+
+> Thank JetBrains for providing an [open-source license](https://jb.gg/OpenSourceSupport), which allows me to use such an excellent IDE.
+
+## License
+
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fsiaikin%2Ftimered-counter.svg?type=large&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Fsiaikin%2Ftimered-counter?ref=badge_large&issueType=license)

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "timered-counter",
-  "description": "Webcomponent timered-counter following open-wc recommendations",
+  "description": "Make the value change more vivid and natural",
   "license": "MIT",
   "author": "timered-counter",
-  "version": "0.0.9",
+  "version": "0.1.0",
   "type": "module",
   "main": "dist/src/index.js",
   "module": "dist/src/index.js",
+  "unpkg": "dist/timered-counter.global.js",
+  "jsdelivr": "dist/timered-counter.global.js",
   "exports": {
     ".": "./dist/src/index.js",
     "./timered-counter.js": "./dist/src/timered-counter.js",
@@ -21,6 +23,14 @@
     "dist"
   ],
   "types": "dist/src/index.d.ts",
+  "keywords": [
+    "timered-counter",
+    "counter",
+    "timer",
+    "countdown",
+    "web-components",
+    "lit"
+  ],
   "scripts": {
     "analyze": "cem analyze --litelement",
     "start": "tsc && concurrently -k -r \"tsc --watch --preserveWatchOutput\" \"web-dev-server\"",