Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
e11sy committed Aug 14, 2024
1 parent ac342e5 commit 3e8b8e4
Showing 1 changed file with 25 additions and 14 deletions.
39 changes: 25 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,33 @@
# typescript-lib-template
A quick start template for a new TypeScript library
Monorepository with several packages usefull for Editor.js and it's tools development

[![NPM version](https://img.shields.io/npm/v/@codexteam/typescript-lib-template?style=flat-square)](https://www.npmjs.com/package/@codexteam/typescript-lib-template)
[![License](https://img.shields.io/npm/l/@codexteam/typescript-lib-template?style=flat-square)](https://www.npmjs.com/package/@codexteam/typescript-lib-template)

## How to use
1. Click [here](https://github.com/codex-team/typescript-lib-template/generate) and fill setting for new repository
2. Change package name in `package.json` and other fields if necessary
3. Change NPM package scope from [workflow file](./.github/workflows/main.yml) or remove it
4. Fill `NPM_TOKEN` and `CODEX_BOT_WEBHOOK` secrets in your repository or organization settings
5. Start writing your new library!

## Features

- TypeScript support
- ESlint support with [eslint-config-codex](http://github.com/codex-team/eslint-config/)
- Unit testing with [Jest](http://jestjs.io)
- GitHub Actions configuration for test/lint/build/publish purposes
## Packages
- Caret
- Dom
- Helpers
- Keyboard

You can use them via installing from npm:

```
npm install @editorjs/caret
npm install @editorjs/helpers
npm install @editorjs/dom
npm install @editorjs/keyboard
```

Or add them to your project as dependencie
```
dependencies: {
"@editorjs/caret": "^0.0.1",
"@editorjs/helpers": "^0.0.1",
"@editorjs/dom": "^0.0.1",
"@editorjs/keyboard": "^0.0.1"
}
```

## About team

Expand Down

0 comments on commit 3e8b8e4

Please sign in to comment.