Updated README.md
This commit is contained in:
parent
bc69efbaef
commit
6e030be8e8
1 changed files with 32 additions and 1 deletions
33
README.md
33
README.md
|
|
@ -1,7 +1,38 @@
|
||||||
# Lotus-PM Client
|
# Lotus-PM Client
|
||||||
|
|
||||||
|
-----------------------------------------------------------------------
|
||||||
|
## General
|
||||||
|
|
||||||
Go verison: 1.17
|
Go verison: 1.17
|
||||||
|
|
||||||
External packages:
|
External packages:
|
||||||
|
|
||||||
- ```github.com/urface/cli/v2```
|
- ``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 <package> <filter>`` | Searches packages on all registries with given filters |
|
||||||
|
| more | coming | soon
|
||||||
|
|
|
||||||
Reference in a new issue