From fe4ba698fbc0c483c98b0aa283824fd0913d8fbb Mon Sep 17 00:00:00 2001
From: lingbopro <ilovemc@zohomail.cn>
Date: Sat, 7 Dec 2024 19:20:18 +0800
Subject: [PATCH] docs: add README

---
 README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..991fab3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# Material-Me
+
+Material-Me is a front-end Web Components library designed with reference to Material You.
+
+Material-Me 是一个前端 Web Components 库，其设计参考了 Material You。
+
+##### NOTE: This library is still in WIP, do not use it for production.
+
+##### 注意：该库仍处于 WIP 状态，请勿将其用于生产。
+
+## Development
+
+prerequisites:
+
+- `Git` installed
+- `Node.js` installed (preferably `>= 22.1.0`)
+- `pnpm` installed (preferably `>= 8`)
+
+```bash
+# clone the repo or your fork
+git clone https://github.com/lingbopro/material-me.git
+cd material-me
+# install dependencies
+pnpm install
+# set up hooks
+pnpm prepare
+# do some modifications...
+
+# build the project
+pnpm build
+# commit your changes
+# NOTE: message should follow the Conventional Commits specification
+# see commitlint.config.js
+git commit -m ...
+# push
+git push
+```