# readmin

> * `npm install readmin --save` * import module `import readmin from 'readmin'` * call module as function `readmin(config)`

Latest version **0.0.2** (published 2016-07-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install readmin
pnpm add readmin
yarn add readmin
bun add readmin
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2016-07-19 |
| First published | 2016-04-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | hcnode |

## Links

- npm: https://www.npmjs.com/package/readmin
- npm.io page: https://npm.io/package/readmin

## Recent versions

- 0.0.2 (latest) — 2016-07-19
- 0.0.1 — 2016-04-12

## README

## Usages 

* `npm install readmin --save`
* import module `import readmin from 'readmin'`
* call module as function `readmin(config)`

## Config


```javascript
    components: [ // content components
		{
			id: "group",
			text: "nginx组",
			component: Group // import react component
		}, {
			id: "node",
			text: "nginx节点",
			component: Node
		}, {
			id: "publish",
			text: "发布",
			component: Publish
		}
	],
	nav: [
		"group", "node", "publish"
	],
	componentDidMount: function () { // hook componentDidMount

	},
	index: function () { // home page
		return <div>test index</div>; 
	},
	containerId: 'container' // content container
```


## Test

* `npm install`
* `npm run build`
* `npm run dev`
* visit http://localhost:8080/

---
_Source: https://npm.io/package/readmin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._