OceanSlim/grain
1
0
Fork 0
mirror of https://github.com/0ceanSlim/grain.git synced 2024-11-22 00:27:14 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

readme change

Browse Source
This commit is contained in:
0ceanSlim 2024-07-31 12:30:42 -04:00
parent cbd4f62466
commit f291c07bfa
1 changed files with 2 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
readme.md
View File

@ -14,19 +14,9 @@ GRAIN is an open-source Nostr relay implementation written in Go. This project a
## Configuration
Configuration options can be set through a configuration file.
Grain will automatically create the configurations and relay metadata files necessary if they do not already exist when you first run the program.
There is an example config in this repo. Copy the example config to config.yml to get started
```bash
cp config.example.yml config.yml
```
Additionally, you may set metadata Information for your relay with `relay_matadata.json`
```bash
cp relay_metadata.example.json relay_metadata.json
```
They are created in the root directory of Grain. Feel free to change any coinfigurations you want in these files.
### TODO