Skip to content

Commit cb61ea6

Browse files
committed
chore: add readme
1 parent 89af6df commit cb61ea6

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

+37
Original file line numberDiff line numberDiff line change
@@ -1 +1,38 @@
11
# api.mojis.dev
2+
3+
A RESTful API for accessing emoji data.
4+
5+
## 📦 Installation
6+
7+
```sh
8+
git clone https://github.com/mojis-dev/api.mojis.dev.git
9+
cd api.mojis.dev
10+
pnpm install
11+
```
12+
13+
## 🚀 Usage
14+
15+
```sh
16+
pnpm run dev
17+
```
18+
19+
> [!NOTE]
20+
> This will copy the emoji data from [mojis/emoji-data](https://github.com/mojis-dev/emoji-data) to the `node_modules/.emoji-data` directory.
21+
> If you want to update this, you can run `pnpm run copy:emoji-data`.
22+
23+
## 📖 API Documentation
24+
25+
The API documentation is available at [api.mojis.dev](https://api.mojis.dev) using Scalar.
26+
27+
## 🔧 Development
28+
29+
The project uses:
30+
31+
- [Hono](https://hono.dev/) for the web framework
32+
- [Cloudflare Workers](https://workers.cloudflare.com/) for deployment
33+
- [Vitest](https://vitest.dev/) for testing
34+
- [Scalar](https://scalar.com/) for API documentation
35+
36+
## 📄 License
37+
38+
Published under [MIT License](./LICENSE).

0 commit comments

Comments
 (0)