forked from TrueCloudLab/frostfs-http-gw
Update README
Signed-off-by: Evgeniy Kulikov <kim@nspcc.ru>
This commit is contained in:
parent
dc7aa694b8
commit
3b8d684e7c
2 changed files with 18 additions and 1 deletions
2
Makefile
2
Makefile
|
@ -17,7 +17,7 @@ R=\033[0m
|
||||||
version:
|
version:
|
||||||
@echo "Current version: $(VERSION)-$(GRPC_VERSION)"
|
@echo "Current version: $(VERSION)-$(GRPC_VERSION)"
|
||||||
|
|
||||||
# Make sure that all files added to commit
|
# Check and ensure dependencies
|
||||||
deps:
|
deps:
|
||||||
@printf "${B}${G}⇒ Ensure vendor${R}: "
|
@printf "${B}${G}⇒ Ensure vendor${R}: "
|
||||||
@go mod tidy -v && echo OK || (echo fail && exit 2)
|
@go mod tidy -v && echo OK || (echo fail && exit 2)
|
||||||
|
|
17
README.md
17
README.md
|
@ -3,6 +3,23 @@
|
||||||
NeoFS HTTP Gate is example of tool that provides basic interactions with NeoFS.
|
NeoFS HTTP Gate is example of tool that provides basic interactions with NeoFS.
|
||||||
You can download files from NeoFS Network using NeoFS Gate.
|
You can download files from NeoFS Network using NeoFS Gate.
|
||||||
|
|
||||||
|
## Notable make targets
|
||||||
|
|
||||||
|
```
|
||||||
|
Usage:
|
||||||
|
|
||||||
|
make <target>
|
||||||
|
|
||||||
|
Targets:
|
||||||
|
|
||||||
|
deps Check and ensure dependencies
|
||||||
|
dev Build development docker images
|
||||||
|
help Show this help prompt
|
||||||
|
image Build docker image
|
||||||
|
publish Publish docker image
|
||||||
|
version Show current version
|
||||||
|
```
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
```go get -u github.com/nspcc-dev/neofs-http-gate```
|
```go get -u github.com/nspcc-dev/neofs-http-gate```
|
||||||
|
|
Loading…
Reference in a new issue