Skip to content

Commit

Permalink
docs: update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
thonatos committed Jan 22, 2024
1 parent 80e4e2d commit 9558755
Show file tree
Hide file tree
Showing 12 changed files with 20 additions and 84 deletions.
68 changes: 9 additions & 59 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,65 +6,15 @@
## Packages

### ArtusX Framework

[![NPM version](https://img.shields.io/npm/v/@artusx/core.svg?style=flat-square)](https://npmjs.org/package/@artusx/core)

```bash
pnpm i @artusx/core
```

**plugins**

- @artusx/plugin-koa

### ArtusX Utils

[![NPM version](https://img.shields.io/npm/v/@artusx/utils.svg?style=flat-square)](https://npmjs.org/package/@artusx/utils)

```bash
pnpm i @artusx/utils
```

### ArtusX Plugins

[![NPM version](https://img.shields.io/npm/v/@artusx/plugin-redis.svg?style=flat-square)](https://npmjs.org/package/@artusx/plugin-redis)

```bash
pnpm i @artusx/plugin-redis
```

---

[![NPM version](https://img.shields.io/npm/v/@artusx/plugin-sequelize.svg?style=flat-square)](https://npmjs.org/package/@artusx/plugin-sequelize)

```bash
pnpm i @artusx/plugin-sequelize
```

---

[![NPM version](https://img.shields.io/npm/v/@artusx/plugin-koa.svg?style=flat-square)](https://npmjs.org/package/@artusx/plugin-koa)

```bash
pnpm i @artusx/plugin-koa
```

---

[![NPM version](https://img.shields.io/npm/v/@artusx/plugin-express.svg?style=flat-square)](https://npmjs.org/package/@artusx/plugin-express)

```bash
pnpm i @artusx/plugin-express
```

---

[![NPM version](https://img.shields.io/npm/v/@artusx/plugin-nest.svg?style=flat-square)](https://npmjs.org/package/@artusx/plugin-nest)

```bash
pnpm i @artusx/plugin-nest
```
| packages | Version |
|:-------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|
| @artusx/core | [![NPM version](https://img.shields.io/npm/v/@artusx/core.svg?style=flat-square)](https://npmjs.org/package/@artusx/core) |
| @artusx/utils | [![NPM version](https://img.shields.io/npm/v/@artusx/utils.svg?style=flat-square)](https://npmjs.org/package/@artusx/utils) |
| @artusx/plugin-koa | [![NPM version](https://img.shields.io/npm/v/@artusx/plugin-koa.svg?style=flat-square)](https://npmjs.org/package/@artusx/plugin-koa) |
| @artusx/plugin-nest | [![NPM version](https://img.shields.io/npm/v/@artusx/plugin-nest.svg?style=flat-square)](https://npmjs.org/package/@artusx/plugin-nest) |
| @artusx/plugin-express | [![NPM version](https://img.shields.io/npm/v/@artusx/plugin-express.svg?style=flat-square)](https://npmjs.org/package/@artusx/plugin-express) |
| @artusx/plugin-redis | [![NPM version](https://img.shields.io/npm/v/@artusx/plugin-redis.svg?style=flat-square)](https://npmjs.org/package/@artusx/plugin-redis) |
| @artusx/plugin-sequelize | [![NPM version](https://img.shields.io/npm/v/@artusx/plugin-sequelize.svg?style=flat-square)](https://npmjs.org/package/@artusx/plugin-sequelize) |

## Example

Expand Down
2 changes: 1 addition & 1 deletion packages/apps/artusx-api/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ArtusX-API
# artusx-api

> undefined project with web-server powered by ArtusX.
Expand Down
2 changes: 1 addition & 1 deletion packages/apps/artusx-express/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ArtusX-Express
# artusx-express

> undefined project with web-server powered by ArtusX.
Expand Down
2 changes: 1 addition & 1 deletion packages/apps/artusx-koa/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ArtusX-Koa
# artusx-koa

> undefined project with web-server powered by ArtusX.
Expand Down
2 changes: 1 addition & 1 deletion packages/apps/artusx-nest/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ArtusX-Nest
# artusx-nest

> undefined project with web-server powered by ArtusX.
Expand Down
4 changes: 1 addition & 3 deletions packages/libs/core/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# ArtusX Core

> https://github.com/thonatos/artusx
# @artusx/core
4 changes: 1 addition & 3 deletions packages/libs/utils/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# ArtusX Utils

> https://github.com/thonatos/artusx
# @artusx/utils
4 changes: 1 addition & 3 deletions packages/plugins/express/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# ArtusX plugin express

> https://github.com/thonatos/artusx
# @artusx/plugin-express
4 changes: 1 addition & 3 deletions packages/plugins/koa/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# ArtusX plugin koa

> https://github.com/thonatos/artusx
# @artusx/plugin-koa
4 changes: 1 addition & 3 deletions packages/plugins/nest/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# ArtusX plugin nest

> https://github.com/thonatos/artusx
# @artusx/plugin-nest
4 changes: 1 addition & 3 deletions packages/plugins/redis/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# ArtusX plugin redis

> https://github.com/thonatos/artusx
# @artusx/plugin-redis
4 changes: 1 addition & 3 deletions packages/plugins/sequelize/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# ArtusX plugin sequelize

> https://github.com/thonatos/artusx
# @artusx/plugin-sequelize

0 comments on commit 9558755

Please sign in to comment.