rewrite: README.md

README.md

@@ -1,2 +1,43 @@
-# Muffin-AI_Arujak
-대충 AI는 아님
+# Muffin-NOT-Ai
+
+- 이 프로젝트는 한 Discord 서버에서 내수용으로 사용할려고 만든 Discord상에서 사용가능한 봇입니다.
+
+## 사용법
+
+### 종속성
+
+- 이 프로젝트는 Node.JS을 사용하고, 패키지 매니저를 Yarn Berry로 사용합니다.
+- 이 프로젝트는 MariaDB(또는 MySQL)를 사용합니다.
+- (개발 버전) 이 프로젝트는 국립국어원의 우리말샘 Open API를 사용합니다. (끝말잇기 기능에 한해)
+
+#### 종속성 설치
+
+```sh
+yarn install
+```
+
+### 설정 파일
+
+- 이 프로젝트는 설정파일을 프로젝트 루트에 있는 `config.json`으로 하며, 그 내용은 `config.example.json`에서 확인할 수 있습니다.
+
+### 실행
+
+위 두 과정을 정상적으로 따랐다면, 아래의 명령어로 봇을 실행할 수 있습니다.
+
+#### 그냥 실행 (디버그용 로그 출력)
+
+```sh
+yarn dev
+```
+
+#### 빌드
+
+```sh
+yarn build
+```
+
+##### 실행
+
+```sh
+yarn start
+```