From d37f460ae1dc21ab7d2bc4205b3521f864306490 Mon Sep 17 00:00:00 2001
From: Koki Sakano <kosakanoki@gmail.com>
Date: Wed, 31 Jul 2024 18:50:12 +0900
Subject: [PATCH] =?UTF-8?q?README=E3=81=AE=E8=A8=98=E8=BF=B0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 92 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 91 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index d5e70a3..145d3ff 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,91 @@
-# Portal Site
+# k8o
+
+This is a website for everything created by k8o!
+
+## setup
+
+Install the package after preparing `Node.js` and `pnpm` with reference to the version described in `package.json`.
+
+```command
+pnpm i --frozen-lockfile
+```
+
+## development
+
+### dev server
+
+Starts the application in development mode with hot-code reloading, error reporting, and more.
+
+```
+pnpm run dev
+```
+
+### storybook
+
+There is a collection of components and a design system.
+
+```command
+pnpm run storybook
+```
+
+### tests
+
+One side is tested by VITEST. It will run in `browser mode` except for the `utils` test.
+
+```command
+pnpm run test
+
+# using Vitest UI
+pnpm run test:ui
+
+# If you want to get covarage result ...
+pnpm run coverage
+```
+
+The other is a test using storybook's test runner
+
+```command
+pnpm run test-storybook
+```
+
+### lint
+
+Using `elsint` affected by `next.js`.
+
+```command
+pnpm run lint
+```
+
+### format
+
+By `prettier`.
+
+```
+pnpm run format
+```
+
+### type-check
+
+It work in `typescript`(`tsc --noEmit`).
+
+```command
+pnpm run type-check
+```
+
+## composition
+
+### framework
+
+[next.js](https://nextjs.org/)
+
+### styling
+
+[tailwdindcss](https://tailwindcss.com/)
+
+### icon
+
+[heroicons](https://heroicons.com/)
+
+### animation
+
+[FramerMotion](https://www.framer.com/motion/)