diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 33ba4ca..c26de50 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/issues) and - [pull requests](https://github.com/nspcc-dev/neofs-api/pulls) for existing +- Check the open [issues](https://github.com/TrueCloudLab/frostfs-api/issues) and + [pull requests](https://github.com/TrueCloudLab/frostfs-api/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` repository, make changes in a branch and then +Start by forking the `frostfs-api` 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/fork) source +Fork [NeoFS node upstream](https://github.com/TrueCloudLab/frostfs-api/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 +$ git clone https://github.com/TrueCloudLab/frostfs-api ``` ### Set up git remote as ``upstream`` ```sh -$ cd neofs-api -$ git remote add upstream https://github.com/nspcc-dev/neofs-api +$ cd frostfs-api +$ git remote add upstream https://github.com/TrueCloudLab/frostfs-api $ 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 be done easily with the `--signoff` option to `git commit`. diff --git a/CREDITS.md b/CREDITS.md index f786376..de610a8 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/README.md b/README.md index ce5ad24..5a262ae 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,22 @@

-NeoFS +FrostFS

- NeoFS API language-agnostic protocol definitions + FrostFS API language-agnostic protocol definitions

--- -![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/nspcc-dev/neofs-api?sort=semver) -![License](https://img.shields.io/github/license/nspcc-dev/neofs-api.svg?style=popout) +![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/TrueCloudLab/frostfs-api?sort=semver) +![License](https://img.shields.io/github/license/TrueCloudLab/frostfs-api.svg?style=popout) ## Overview -NeoFS-API repository is the basis for language-specific libraries, e.g.: +FrostFS-API repository is the basis for language-specific libraries, e.g.: -- [neofs-api-go](https://github.com/nspcc-dev/neofs-api-go) -- [neofs-api-csharp](https://github.com/nspcc-dev/neofs-api-csharp) +- [frostfs-api-go](https://github.com/TrueCloudLab/frostfs-api-go) Those libraries contain compiled protocol buffers definitions, wrapped with -language-specific code. Use them to integrate applications with NeoFS. +language-specific code. Use them to integrate applications with FrostFS. This repository contains: