Skip to content

Commit

Permalink
docs: complete first draft
Browse files Browse the repository at this point in the history
  • Loading branch information
fraxken committed May 31, 2019
1 parent 14d2296 commit 36356e6
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,24 @@ SlimIO Aggregator

## Requirements
- Node.js v10 or higher
- [SlimIO Agent](https://github.com/SlimIO/Agent)

## Getting Started
TBC
This package is available in the SlimIO Package Registry and can be easily installed with [SlimIO CLI](https://github.com/SlimIO/CLI).

## Usage example
TBC
```bash
$ slimio --add aggregator
# or
$ slimio --add https://github.com/SlimIO/Aggregator
```

## API
TBC
> Note: this addon is automatically installed with the slimio -i command.
## Dependencies

|Name|Refactoring|Security Risk|Usage|
|---|---|---|---|
|[@slimio/addon](https://github.com/SlimIO/Addon#readme)|⚠️Major|Low|Addon default class|

## License
MIT

0 comments on commit 36356e6

Please sign in to comment.