diff --git a/README.md b/README.md index 5cb3a70..85f2a6e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,38 @@ # Lotus-PM Client +----------------------------------------------------------------------- +## General + Go verison: 1.17 External packages: -- ```github.com/urface/cli/v2``` \ No newline at end of file +- ``github.com/urface/cli/v2`` +- ``github.com/olekukonko/tablewriter`` +- ``github.com/sirupsen/logrus`` +- ``google.golang.org/grpc`` +- ``google.golang.org/protobuf`` + +--------------------------------------------------------------------------- +## Installation & Usage + +### Requirements +- Golang 17 + +### Installation + +- Pull the repository with ``git clone https://github.com/lpn-group/lpm-cli.git`` +- Go into the directory +- Use ``go build`` + +### Usage + +- Use ``lpm-cli`` to get all commands shown. Or take a look at [Commands](#commands) + +------------------------------------------------------------------------------ +## Commands + +| Command | Usage | Description | +|:-----------------:|:----------------------------------------:|----------------------------------------------------------------------| +| ``search`` | ``lpm-cli search `` | Searches packages on all registries with given filters | +| more | coming | soon