From 0ccd8828d0737dcdea9095509187877bf452891f Mon Sep 17 00:00:00 2001 From: Sergey Fuksman Date: Mon, 10 Jul 2023 13:55:35 +0300 Subject: [PATCH 1/4] Update README.md --- README.md | 33 ++++++++++++++++++++++++--------- 1 file changed, 24 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 8a3e4e94..f5f0f90e 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,26 @@ -# Anytype node -To build and run the Anytype Node on your own server, follow these technical steps: +# Any-Sync Node +Implementation of node from [`any-sync`](https://github.com/anyproto/any-sync) protocol. -1. Clone the Anytype Node repository to your local machine. +## Building the source +To build and run the Any-Sync Node on your own server, follow these technical steps: + +1. Clone the Any-Sync Node repository to your local machine. 2. Navigate to the root directory of the repository, where you will find a `Makefile`. -3. Run the command `make deps` to install the required dependencies for the Anytype Node.* -4. Run the command `make build` to build the Anytype Node.* -5. If there are no errors, the Anytype Node will be built and can be found in the `/bin` directory. +3. Run the command `make deps` to install the required dependencies for the Any-Sync Node.* +4. Run the command `make build` to build the Any-Sync Node.* +5. If there are no errors, the Any-Sync Node will be built and can be found in the `/bin` directory. *To avoid any Go language version incompatibility issues, please use version `1.19` of Go. -When running the Anytype Node, you can use the following options: +When running the Any-Sync Node, you can use the following options: - `-c` Every node should be run with the configuration file option. By default, the option flag is set to `etc/any-sync-node.yml.` You can always generate a new configuration using the appropriate command **???** - - `-v` This option shows the current version of the Anytype Node and then exits. + - `-v` This option shows the current version of the Any-Sync Node and then exits. - `-h` This option shows the help message and then exits. -## Graph example of using anytype nodes group +## Graph example of using Any-Sync Nodes group ```mermaid graph LR @@ -27,3 +30,15 @@ C -- Sync --> A U[Client] --> A ``` + +## Contribution +Thank you for your desire to develop Anytype together. + +Currently, we're not ready to accept PRs, but we will in the nearest future. + +Follow us on [Github](https://github.com/anyproto) and join the [Contributors Community](https://github.com/orgs/anyproto/discussions). + +--- +Made by Any — a Swiss association 🇨🇭 + +Licensed under [MIT License](./LICENSE.md). \ No newline at end of file From 1045a76963a472095258119fe26296b8d86c0043 Mon Sep 17 00:00:00 2001 From: Sergey Fuksman Date: Mon, 10 Jul 2023 14:05:02 +0300 Subject: [PATCH 2/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f5f0f90e..66706f0b 100644 --- a/README.md +++ b/README.md @@ -41,4 +41,4 @@ Follow us on [Github](https://github.com/anyproto) and join the [Contributors Co --- Made by Any — a Swiss association 🇨🇭 -Licensed under [MIT License](./LICENSE.md). \ No newline at end of file +Licensed under [MIT License](./LICENSE). From ae9631bb8051518ccf27edf8715abf5f31eff609 Mon Sep 17 00:00:00 2001 From: Sergey Fuksman Date: Mon, 10 Jul 2023 14:10:49 +0300 Subject: [PATCH 3/4] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 66706f0b..4ed5a3d8 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ To build and run the Any-Sync Node on your own server, follow these technical st *To avoid any Go language version incompatibility issues, please use version `1.19` of Go. +## Running When running the Any-Sync Node, you can use the following options: - `-c` Every node should be run with the configuration file option. By From b1e7e4c6b5131a07b945796b384c7273f9e45217 Mon Sep 17 00:00:00 2001 From: Sergey Fuksman Date: Thu, 13 Jul 2023 14:54:38 +0300 Subject: [PATCH 4/4] Update README.md --- README.md | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 4ed5a3d8..f19b1986 100644 --- a/README.md +++ b/README.md @@ -2,24 +2,27 @@ Implementation of node from [`any-sync`](https://github.com/anyproto/any-sync) protocol. ## Building the source -To build and run the Any-Sync Node on your own server, follow these technical steps: +To ensure compatibility, please use Go version `1.19`. -1. Clone the Any-Sync Node repository to your local machine. -2. Navigate to the root directory of the repository, where you will find a `Makefile`. -3. Run the command `make deps` to install the required dependencies for the Any-Sync Node.* -4. Run the command `make build` to build the Any-Sync Node.* -5. If there are no errors, the Any-Sync Node will be built and can be found in the `/bin` directory. +To build and run the Any-Sync Node on your own server, follow these steps: -*To avoid any Go language version incompatibility issues, please use version `1.19` of Go. +1. Clone `any-sync-node` repository. +2. Navigate to the root directory of the repository. +3. Run the following commands to install the required dependencies and build the Any-Sync Node. + ``` + make deps + make build + ``` +4. If there are no errors, the Any-Sync Node will be built and can be found in the `/bin` directory. ## Running -When running the Any-Sync Node, you can use the following options: +Any-Sync Node requires a configuration. You can generate configuration files for your nodes with [`any-sync-network`](https://github.com/anyproto/any-sync-tools) tool. - - `-c` Every node should be run with the configuration file option. By - default, the option flag is set to `etc/any-sync-node.yml.` You can - always generate a new configuration using the appropriate command **???** - - `-v` This option shows the current version of the Any-Sync Node and then exits. - - `-h` This option shows the help message and then exits. +The following options are available for running the Any-Sync Node: + + - `-c` — path to config file (default `etc/any-sync-node.yml`). + - `-v` — current version. + - `-h` — help message. ## Graph example of using Any-Sync Nodes group