From 6e0b242a8f20cfb2e8d396114327258970bebfc5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=ED=8C=8C=EB=A7=81?= <paring@pikokr.dev>
Date: Thu, 30 Mar 2023 15:04:34 +0900
Subject: [PATCH] :memo: readme

---
 README.md    | 24 ++++++++++++++++++++++++
 package.json |  4 ++++
 2 files changed, 28 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..15071d3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# ADOFAI Typegen
+
+Typescript type generator for ADOFAI events
+
+## Usage
+
+First, setup registry.
+
+```shell
+npm config set @pikokr-gitea:registry https://git.pikokr.dev/api/packages/pikokr/npm/
+npm config set -- '//git.pikokr.dev/api/packages/pikokr/npm/:_authToken' "<PAT>"
+```
+
+Install package
+
+```shell
+npm i -g @pikokr-gitea/adofai-typegen
+```
+
+Run
+
+```shell
+adofai-typegen https://example.com/properties.json
+```
diff --git a/package.json b/package.json
index 81aa6ba..34b6b11 100644
--- a/package.json
+++ b/package.json
@@ -3,6 +3,10 @@
   "version": "0.0.1",
   "description": "",
   "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://git.pikokr.dev/pikokr/adofai-typegen"
+  },
   "scripts": {
     "dev": "tsx src",
     "build": "tsup",