From b2c8229090135084c22cd641eff727dd889b4895 Mon Sep 17 00:00:00 2001
From: mpppk <niboshiporipori@gmail.com>
Date: Fri, 13 Dec 2024 00:02:05 +0900
Subject: [PATCH] Add main readme

---
 pkgs/docs/README.md | 41 -----------------------------------------
 readme.md           | 10 ++++++++++
 2 files changed, 10 insertions(+), 41 deletions(-)
 delete mode 100644 pkgs/docs/README.md
 create mode 100644 readme.md

diff --git a/pkgs/docs/README.md b/pkgs/docs/README.md
deleted file mode 100644
index 0c6c2c2..0000000
--- a/pkgs/docs/README.md
+++ /dev/null
@@ -1,41 +0,0 @@
-# Website
-
-This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
-
-### Installation
-
-```
-$ yarn
-```
-
-### Local Development
-
-```
-$ yarn start
-```
-
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
-
-### Build
-
-```
-$ yarn build
-```
-
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
-
-### Deployment
-
-Using SSH:
-
-```
-$ USE_SSH=true yarn deploy
-```
-
-Not using SSH:
-
-```
-$ GIT_USER=<Your GitHub username> yarn deploy
-```
-
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..88ffa67
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,10 @@
+# typed-api-spec monorepo
+
+* pkgs/typed-api-spec
+  * main module of the typed-api-spec package
+  * It can be installed via `npm install @notainc/typed-api-spec`
+* pkgs/docs
+  * documentation for the typed-api-spec package
+  * hosted on nota.github.io/typed-api-spec/
+* pkgs/examples
+  * examples of using the typed-api-spec package
\ No newline at end of file