Rebranding

FrostFS continues the development of NeoFS.

Signed-off-by: Stanislav Bogatyrev <s.bogatyrev@yadro.com>
This commit is contained in:
Stanislav Bogatyrev 2022-12-08 14:22:14 +03:00
parent dcabc511f3
commit 653e1f92aa
3 changed files with 17 additions and 16 deletions

View file

@ -3,8 +3,8 @@
First, thank you for contributing! We love and encourage pull requests from First, thank you for contributing! We love and encourage pull requests from
everyone. Please follow the guidelines: everyone. Please follow the guidelines:
- Check the open [issues](https://github.com/nspcc-dev/neofs-api/issues) and - Check the open [issues](https://github.com/TrueCloudLab/frostfs-api/issues) and
[pull requests](https://github.com/nspcc-dev/neofs-api/pulls) for existing [pull requests](https://github.com/TrueCloudLab/frostfs-api/pulls) for existing
discussions. discussions.
- Open an issue first, to discuss a new feature or enhancement. - Open an issue first, to discuss a new feature or enhancement.
@ -21,23 +21,23 @@ everyone. Please follow the guidelines:
## Development Workflow ## 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 send a pull request. We encourage pull requests to discuss code changes. Here
are the steps in details: are the steps in details:
### Set up your GitHub Repository ### 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 repository to your own personal repository. Copy the URL of your fork (you will
need it for the `git clone` command below). need it for the `git clone` command below).
```sh ```sh
$ git clone https://github.com/nspcc-dev/neofs-api $ git clone https://github.com/TrueCloudLab/frostfs-api
``` ```
### Set up git remote as ``upstream`` ### Set up git remote as ``upstream``
```sh ```sh
$ cd neofs-api $ cd frostfs-api
$ git remote add upstream https://github.com/nspcc-dev/neofs-api $ git remote add upstream https://github.com/TrueCloudLab/frostfs-api
$ git fetch upstream $ git fetch upstream
$ git merge upstream/master $ 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: To sign your work, just add a line like this at the end of your commit message:
``` ```
Signed-off-by: Samii Sakisaka <samii@nspcc.ru> Signed-off-by: Samii Sakisaka <samii@ivunojikan.co.jp>
``` ```
This can be done easily with the `--signoff` option to `git commit`. This can be done easily with the `--signoff` option to `git commit`.

View file

@ -1,5 +1,7 @@
# Credits # Credits
FrostFS continues the development of NeoFS.
Initial NeoFS research and development (2018-2020) was done by Initial NeoFS research and development (2018-2020) was done by
[NeoSPCC](https://nspcc.ru) team. [NeoSPCC](https://nspcc.ru) team.

View file

@ -1,23 +1,22 @@
<p align="center"> <p align="center">
<img src="./.github/logo.svg" width="500px" alt="NeoFS"> <img src="./.github/logo.svg" width="500px" alt="FrostFS">
</p> </p>
<p align="center"> <p align="center">
<a href="https://fs.neo.org">NeoFS</a> API language-agnostic protocol definitions <a href="https://objectstorage.info">FrostFS</a> API language-agnostic protocol definitions
</p> </p>
--- ---
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/nspcc-dev/neofs-api?sort=semver) ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/TrueCloudLab/frostfs-api?sort=semver)
![License](https://img.shields.io/github/license/nspcc-dev/neofs-api.svg?style=popout) ![License](https://img.shields.io/github/license/TrueCloudLab/frostfs-api.svg?style=popout)
## Overview ## 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) - [frostfs-api-go](https://github.com/TrueCloudLab/frostfs-api-go)
- [neofs-api-csharp](https://github.com/nspcc-dev/neofs-api-csharp)
Those libraries contain compiled protocol buffers definitions, wrapped with 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: This repository contains: