diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 99dfb26a..baa77253 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,8 +3,8 @@ First, thank you for contributing! We love and encourage pull requests from everyone. Please follow the guidelines: -- Check the open [issues](https://github.com/nspcc-dev/neofs-api-go/issues) and - [pull requests](https://github.com/nspcc-dev/neofs-api-go/pulls) for existing +- Check the open [issues](https://github.com/TrueCloudLab/frostfs-api-go/issues) and + [pull requests](https://github.com/TrueCloudLab/frostfs-api-go/pulls) for existing discussions. - Open an issue first, to discuss a new feature or enhancement. @@ -21,23 +21,23 @@ everyone. Please follow the guidelines: ## Development Workflow -Start by forking the `neofs-api-go` repository, make changes in a branch and then +Start by forking the `frostfs-api-go` repository, make changes in a branch and then send a pull request. We encourage pull requests to discuss code changes. Here are the steps in details: ### Set up your GitHub Repository -Fork [NeoFS node upstream](https://github.com/nspcc-dev/neofs-api-go/fork) source +Fork [FrostFS node upstream](https://github.com/TrueCloudLab/frostfs-api-go/fork) source repository to your own personal repository. Copy the URL of your fork (you will need it for the `git clone` command below). ```sh -$ git clone https://github.com/nspcc-dev/neofs-api-go +$ git clone https://github.com/TrueCloudLab/frostfs-api-go ``` ### Set up git remote as ``upstream`` ```sh -$ cd neofs-api-go -$ git remote add upstream https://github.com/nspcc-dev/neofs-api-go +$ cd frostfs-api-go +$ git remote add upstream https://github.com/TrueCloudLab/frostfs-api-go $ git fetch upstream $ git merge upstream/master ... @@ -103,7 +103,7 @@ contributors". To sign your work, just add a line like this at the end of your commit message: ``` -Signed-off-by: Samii Sakisaka +Signed-off-by: Samii Sakisaka ``` This can easily be done with the `--signoff` option to `git commit`. diff --git a/CREDITS.md b/CREDITS.md index b640f64c..a868b21b 100644 --- a/CREDITS.md +++ b/CREDITS.md @@ -1,5 +1,7 @@ # Credits +FrostFS continues the development of NeoFS. + Initial NeoFS research and development (2018-2020) was done by [NeoSPCC](https://nspcc.ru) team. diff --git a/Makefile b/Makefile index 25324e9b..6ceea252 100644 --- a/Makefile +++ b/Makefile @@ -39,7 +39,7 @@ imports: # Regenerate code for proto files protoc: - @GOPRIVATE=github.com/nspcc-dev go mod vendor + @GOPRIVATE=github.com/TrueCloudLab go mod vendor # Install specific version for protobuf lib @go list -f '{{.Path}}/...@{{.Version}}' -m google.golang.org/protobuf | xargs go install -v # Protoc generate diff --git a/README.md b/README.md index 5edeb842..5dd56c29 100644 --- a/README.md +++ b/README.md @@ -2,40 +2,26 @@ NeoFS

- Low-level Golang API for NeoFS + Low-level Golang API for FrostFS

--- -![Tests](https://github.com/nspcc-dev/neofs-api-go/workflows/neofs-api-go%20tests/badge.svg) -[![codecov](https://codecov.io/gh/nspcc-dev/neofs-api-go/branch/master/graph/badge.svg)](https://codecov.io/gh/nspcc-dev/neofs-api-go) -[![Report](https://goreportcard.com/badge/github.com/nspcc-dev/neofs-api-go)](https://goreportcard.com/report/github.com/nspcc-dev/neofs-api-go) -[![GitHub release](https://img.shields.io/github/release/nspcc-dev/neofs-api-go.svg)](https://github.com/nspcc-dev/neofs-api-go) -![GitHub license](https://img.shields.io/github/license/nspcc-dev/neofs-api-go.svg?style=popout) +![Tests](https://github.com/TrueCloudLab/frostfs-api-go/workflows/frostfs-api-go%20tests/badge.svg) +[![codecov](https://codecov.io/gh/TrueCloudLab/frostfs-api-go/branch/master/graph/badge.svg)](https://codecov.io/gh/TrueCloudLab/frostfs-api-go) +[![Report](https://goreportcard.com/badge/github.com/TrueCloudLab/frostfs-api-go)](https://goreportcard.com/report/github.com/TrueCloudLab/frostfs-api-go) +[![GitHub release](https://img.shields.io/github/release/TrueCloudLab/frostfs-api-go.svg)](https://github.com/TrueCloudLab/frostfs-api-go) +![GitHub license](https://img.shields.io/github/license/TrueCloudLab/frostfs-api-go.svg?style=popout) # Overview -Go implementation of recent [NeoFS API](https://github.com/nspcc-dev/neofs-api) -versions. For a more high-level SDK see [NeoFS SDK](https://github.com/nspcc-dev/neofs-sdk-go). +Go implementation of recent [FrostFS API](https://github.com/TrueCloudLab/frostfs-api) +versions. For a more high-level SDK see [FrostFS SDK](https://github.com/TrueCloudLab/frostfs-sdk-go). -## NeoFS-API compatibility +## Frostfs-Api compatibility -|neofs-api-go version|supported NeoFS-API versions| +|frostfs-api-go version|supported frostfs-api versions| |:------------------:|:--------------------------:| -|< v1.20.0 **(unsupported)**|up to v1.2.0| -|v1.20.x|[v2.0.2](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.0.2)| -|v1.21.x|[v2.1.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.1.0)| -|v1.22.x|[v2.2.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.2.0)| -|v1.23.x|[v2.3.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.3.0)| -|v1.24.x|[v2.4.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.4.0)| -|v1.25.x|[v2.5.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.5.0)| -|v1.26.x|[v2.6.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.6.0)| -|v1.27.x|[v2.7.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.7.0)| -|v1.28.x|[v2.8.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.8.0)| -|v1.29.x|[v2.9.1](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.9.1)| -|v1.30.x|[v2.10.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.10.0)| -|v2.11.x|[v2.11.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.11.0)| -|v2.12.x|[v2.12.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.12.0)| -|v2.13.x|[v2.13.0](https://github.com/nspcc-dev/neofs-api/releases/tag/v2.13.0)| +|v2.14.x|[v2.14.0](https://github.com/TrueCloudLab/frostfs-api/releases/tag/v2.14.0)| ## Contributing diff --git a/prepare.sh b/prepare.sh index 2dd72630..32048b34 100755 --- a/prepare.sh +++ b/prepare.sh @@ -1,7 +1,7 @@ #!/bin/bash if [ -z "$1" ]; then - echo "usage: ./prepare.sh path/to/neofs-api" + echo "usage: ./prepare.sh path/to/frostfs-api" exit 1 fi