Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

补充文档 & 功能添加 #6

Merged
merged 13 commits into from
Sep 20, 2021
Prev Previous commit
Next Next commit
📝 update: packages/**/README.md
  • Loading branch information
KusStar committed Sep 3, 2021
commit 79d8d59bcb003e7b1b2d06e19e8b7ddbfef9e137
10 changes: 9 additions & 1 deletion packages/core/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# mincu-core

> [Mincu - 南大家园 WEB JS API](https://github.com/ncuhome/mincu)
[Mincu - 南大家园 WEB JS API](https://github.com/ncuhome/mincu)

## Install

```cmd
$ yarn add mincu-core
# or
$ npm install mincu-core
```
10 changes: 9 additions & 1 deletion packages/data/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# mincu-data

> [Mincu - 南大家园 WEB JS API](https://github.com/ncuhome/mincu)
[Mincu - 南大家园 WEB JS API](https://github.com/ncuhome/mincu)

## Install

```cmd
$ yarn add mincu-data
# or
$ npm install mincu-data
```
51 changes: 50 additions & 1 deletion packages/debug/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,52 @@
# mincu-debug

> [Mincu - 南大家园 WEB JS API](https://github.com/ncuhome/mincu)
[Mincu - 南大家园 WEB JS API](https://github.com/ncuhome/mincu)

# mincu-data

[Mincu - 南大家园 WEB JS API](https://github.com/ncuhome/mincu)

## Install

```cmd
$ yarn add -D mincu-debug
# or
$ npm install -save-dev mincu-debug
```

## Usage

```cmd
$ npx mincud

**** **** ** **** ** ****** ** **
/**/** **/**/**/**/** /** **////**/** /**
/**//** ** /**/**/**//** /** ** // /** /**
/** //*** /**/**/** //** /**/** /** /**
/** //* /**/**/** //**/**/** /** /**
/** / /**/**/** //****//** **/** /**
/** /**/**/** //*** //****** //*******
// // // // /// ////// ///////
Welcome to MINCU Damon!
!Fast - !Scalable - !Integrated

listening on ws://localhost:2333


To reload the client page press "r"
To toggle the client devtool press "d"
```

```cmd
$ npx mincud -h

Usage
$ mincud <command> [options]

Options
--no-qrcode, Disable qrcode generation
--no-server-command, Disable handling server command

Examples
$ mincud 'npm run dev'
```
10 changes: 9 additions & 1 deletion packages/event/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# mincu-event

> [Mincu - 南大家园 WEB JS API](https://github.com/ncuhome/mincu)
[Mincu - 南大家园 WEB JS API](https://github.com/ncuhome/mincu)

## Install

```cmd
$ yarn add mincu-event
# or
$ npm install mincu-event
```
10 changes: 9 additions & 1 deletion packages/hooks/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# mincu-hooks

> [Mincu - 南大家园 WEB JS API](https://github.com/ncuhome/mincu)
[Mincu - 南大家园 WEB JS API](https://github.com/ncuhome/mincu)

## Install

```cmd
$ yarn add mincu-hooks
# or
$ npm install mincu-hooks
```
10 changes: 9 additions & 1 deletion packages/lib/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# mincu-lib

> [Mincu - 南大家园 WEB JS API](https://github.com/ncuhome/mincu)
[Mincu - 南大家园 WEB JS API](https://github.com/ncuhome/mincu)

## Install

```cmd
$ yarn add mincu-lib
# or
$ npm install mincu-lib
```
10 changes: 9 additions & 1 deletion packages/network/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# mincu-network

> [Mincu - 南大家园 WEB JS API](https://github.com/ncuhome/mincu)
[Mincu - 南大家园 WEB JS API](https://github.com/ncuhome/mincu)

## Install

```cmd
$ yarn add mincu-network
# or
$ npm install mincu-network
```
10 changes: 9 additions & 1 deletion packages/react/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# mincu-react

> [Mincu - 南大家园 WEB JS API](https://github.com/ncuhome/mincu)
[Mincu - 南大家园 WEB JS API](https://github.com/ncuhome/mincu)

## Install

```cmd
$ yarn add mincu-react
# or
$ npm install mincu-react
```
10 changes: 9 additions & 1 deletion packages/ui/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# mincu-ui

> [Mincu - 南大家园 WEB JS API](https://github.com/ncuhome/mincu)
[Mincu - 南大家园 WEB JS API](https://github.com/ncuhome/mincu)

## Install

```cmd
$ yarn add mincu-ui
# or
$ npm install mincu-ui
```
10 changes: 9 additions & 1 deletion packages/vanilla/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# mincu-vanilla

> [Mincu - 南大家园 WEB JS API](https://github.com/ncuhome/mincu)
[Mincu - 南大家园 WEB JS API](https://github.com/ncuhome/mincu)

## Install

```cmd
$ yarn add mincu-vanilla
# or
$ npm install mincu-vanilla
```