textplace/CoreTextPlace
1
0
Fork 0
mirror of https://github.com/TextPlace/CoreTextPlace.git synced 2025-04-30 20:51:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: add README.md

Browse source
This commit is contained in:
Shibo Lyu 2024-05-05 12:26:15 +08:00
parent 3cdb7c7246
commit 4d0ca6772a
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md Normal file
View file

@ -0,0 +1,15 @@
# CoreTextPlace
[![JSR](https://jsr.io/badges/@textplace/core)](https://jsr.io/@textplace/core)
[![JSR Score](https://jsr.io/badges/@textplace/core/score)](https://jsr.io/@textplace/core)
[![Deno Tests](https://github.com/textplace/CoreTextPlace/actions/workflows/deno.yml/badge.svg)](https://github.com/textplace/CoreTextPlace/actions/workflows/deno.yml)
The core logic & type defnitions of [TextPlace](https://t.me/s/gotextplace).
This is written in TypeScript and should be able to run on browsers (web app uses it), Cloudflare Workers (that TextPlace backend runs on) and Deno (for development & main test platform). Compatibility with Node.js and Bun is not guranteed but issues & PRs are welcome.
This is available on both [JSR](https://jsr.io/@textplace/core) and [NPM](https://www.npmjs.com/package/@textplace/core). It's published on JSR as long as the tests are passing, and only published to NPM when a new release is tagged.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.