diff --git a/README.md b/README.md index 4ed5a3d..f19b198 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