From 4d0ca6772a16247d0860fc3c29d0693b26473e1f Mon Sep 17 00:00:00 2001 From: Shibo Lyu Date: Sun, 5 May 2024 12:26:15 +0800 Subject: [PATCH] doc: add README.md --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..6da3ba9 --- /dev/null +++ b/README.md @@ -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.