docs: update README (#113)

CODE_OF_CONDUCT.md

@@ -0,0 +1,127 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -1,6 +1,6 @@
-# Modern.js Contributing Guide
+# Reduck Contributing Guide
 
-Thanks for that you are interested in contributing to Modern.js.
+Thanks for that you are interested in contributing to Reduck.
 
 ## Developing
 
@@ -34,11 +34,8 @@ To develop locally:
     cd ./packages/
     ```
 
-6. Start developing and watch for code changes:
+6. Start developing.
 
-   ```zsh
-   pnpm dev
-   ```
 
 ## Building
 
@@ -52,7 +49,7 @@ pnpm build
 build all packages, with:
 
 ```zsh
-pnpm prepare
+pnpm -r prepare
 ```
 
 If you need to clean all `node_modules/*` the project for any reason, with
@@ -63,14 +60,14 @@ pnpm reset
 
 ## Testing
 
-You need write th new tests for new feature or modify exist tests for changes.
+You need write new test cases for new feature or modify existing test cases for changes.
 
-We wish you write unit tests at `PACKAGE_DIR/tests`. Test syntax is based on [jest](https://jestjs.io/).
+We wish you write unit tests at `PACKAGE_DIR/__test__`. Test syntax is based on [jest](https://jestjs.io/).
 
 ### Run Testing
 
 ```sh
-pnpm test
+pnpm -r test
 ```
 
 ## Linting
@@ -94,25 +91,19 @@ Repository maintainers can publish a new version of all packages to npm.
     pnpm run setup
     ```
 
-3. Prepare
-
-    ```zsh
-    pnpm prepare
-    ```
-
-4. Add changeset
+3. Add changeset
 
    ```zsh
    pnpm change
    ```
 
-5. Bump version
+4. Bump version
 
    ```zsh
    pnpm bump
    ```
 
-6. Commit version change. The format of commit message should be `chore: va.b.c` which is the main version of current release.
+5. Commit version change. The format of commit message should be `chore: va.b.c` which is the main version of current release.
 
     ```zsh
     git add .

README.md

@@ -1,35 +1,45 @@
-
 <p align="center">
-  <a href="https://modernjs.dev" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png" width="300" alt="Modern.js Logo" /></a>
+  <a href="https://modernjs.dev" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png" width="260" alt="Modern.js Logo" /></a>
 </p>
+
+<h1 align="center">Reduck</h1>
+
 <p align="center">
-现代 Web 工程体系
-  <br/>
-  <a href="https://modernjs.dev" target="blank">
-    modernjs.dev
-  </a>
+  A Redux-based state management library.
 </p>
+
 <p align="center">
-  The meta-framework suite designed from scratch for frontend-focused modern web development
+  <img src="https://img.shields.io/npm/v/@modern-js-reduck/store?style=flat-square&color=00a8f0" alt="npm version" />
+  <img src="https://img.shields.io/npm/dm/@modern-js-reduck/store?style=flat-square&color=00a8f0" alt="downloads" />
+  <img src="https://img.shields.io/npm/l/@modern-js-reduck/store?style=flat-square&color=00a8f0" alt="License" />
 </p>
 
-# Introduction
-
-> The doc site ([modernjs.dev](https://modernjs.dev)) and articles are only available in Chinese for now, we are planning to add English versions soon.
+## Introduction
 
-- [Modern.js: Hello, World!](https://zhuanlan.zhihu.com/p/426707646)
+Reduck is a Redux-based state management library that offers simple APIs and less boilerplate codes.
+It can be used out of the box within Modern.js, which is also recommended, or it can be used directly.
 
-## Getting Started
+## Documentation
 
-- [Quick Start](https://modernjs.dev/docs/start)
-- [Guides](https://modernjs.dev/docs/guides)
-- [API References](https://modernjs.dev/docs/api)
-
-## Contributing
-
-- [Contributing Guide](/CONTRIBUTING.md)
+The Reduck docs are located at : https://modernjs.dev/en/guides/topic-detail/model/quick-start.
 
 # Examples
 - [todos](https://stackblitz.com/github/modern-js-dev/reduck/tree/main/examples/todos?file=src%2Findex.tsx&terminal=start&title=todos)
 - [vanilla-counter](https://stackblitz.com/github/modern-js-dev/reduck/tree/main/examples/vanilla-counter?file=index.html&terminal=dev&title=vanilla-counter)
 - [vite-counter](https://stackblitz.com/github/modern-js-dev/reduck/tree/main/examples/vite-counter?file=src%2FApp.tsx&terminal=dev&title=vite-counter)
+
+
+## Contributing
+
+> New contributors welcome!
+
+Please read the [Contributing Guide](https://github.com/web-infra-dev/modern.js/blob/main/CONTRIBUTING.md).
+
+### Code of Conduct
+
+This repo has adopted the Bytedance Open Source Code of Conduct. Please check [Code of Conduct](./CODE_OF_CONDUCT.md) for more details.
+
+
+## License
+
+Reduck is [MIT licensed](https://github.com/web-infra-dev/reduck/blob/main/LICENSE).