diff options
Diffstat (limited to 'node_modules/regenerate-unicode-properties/README.md')
| -rw-r--r-- | node_modules/regenerate-unicode-properties/README.md | 70 |
1 files changed, 0 insertions, 70 deletions
diff --git a/node_modules/regenerate-unicode-properties/README.md b/node_modules/regenerate-unicode-properties/README.md deleted file mode 100644 index 392a75d2..00000000 --- a/node_modules/regenerate-unicode-properties/README.md +++ /dev/null @@ -1,70 +0,0 @@ -# regenerate-unicode-properties [](https://www.npmjs.com/package/regenerate-unicode-properties) - -_regenerate-unicode-properties_ is a collection of [Regenerate](https://github.com/mathiasbynens/regenerate) sets for [various Unicode properties](https://github.com/tc39/proposal-regexp-unicode-property-escapes). - -## Installation - -To use _regenerate-unicode-properties_ programmatically, install it as a dependency via [npm](https://www.npmjs.com/): - -```bash -$ npm install regenerate-unicode-properties -``` - -## Usage - -To get a map of supported properties and their values: - -```js -const properties = require('regenerate-unicode-properties'); -``` - -To get a specific Regenerate set: - -```js -// Examples: -const Lu = require('regenerate-unicode-properties/General_Category/Uppercase_Letter.js').characters; -const Greek = require('regenerate-unicode-properties/Script_Extensions/Greek.js').characters; -``` - -Some properties can also refer to strings rather than single characters: -```js -const { characters, strings } = require('regenerate-unicode-properties/Property_of_Strings/Basic_Emoji.js'); -``` - -To get the Unicode version the data was based on: - -```js -const unicodeVersion = require('regenerate-unicode-properties/unicode-version.js'); -``` - -## For maintainers - -### How to publish a new release - -1. On the `main` branch, bump the version number in `package.json`: - - ```sh - npm version patch -m 'Release v%s' - ``` - - Instead of `patch`, use `minor` or `major` [as needed](https://semver.org/). - - Note that this produces a Git commit + tag. - -1. Push the release commit and tag: - - ```sh - git push && git push --tags - ``` - - Our CI then automatically publishes the new release to npm. - -## Author - -| [](https://twitter.com/mathias "Follow @mathias on Twitter") | -|---| -| [Mathias Bynens](https://mathiasbynens.be/) | - -## License - -_regenerate-unicode-properties_ is available under the [MIT](https://mths.be/mit) license. |