Skip to content

Commit

Permalink
docs: add README
Browse files Browse the repository at this point in the history
  • Loading branch information
lingbopro committed Dec 7, 2024
1 parent c4ec788 commit fe4ba69
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit fe4ba69

Please sign in to comment.