MeexReay/racinfo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(readme): my readme for racinfo

Browse Source
This commit is contained in:
MeexReay 2025-08-30 12:29:47 +03:00
parent 7c1a188876
commit 6b07b92400
1 changed files with 4 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -3,7 +3,7 @@
An unofficial webpage with information about Real Address Chat protocol made with Next.js.
This is a personal project and is not affiliated with the original Real Address Chat developer.
[Live in production website](https://racinfo.kostyazero.com)
[Live in production website](https://racinfo.meex.lol)
## Features
@ -18,14 +18,14 @@ It is strongly recommended to use Docker to host Racinfo. You can use the follow
```bash
docker build -t racinfo .
docker up -d -p 8085:8085 racinfo
docker run -d -p 8085:8085 racinfo
```
By default, Racinfo runs on port 8085. You can change this by using the -p flag with the docker run command, like this:
```bash
# Instead of 8085, you can use any port you want, like 3000
docker up -d -p 3000:8085 racinfo
docker run -d -p 3000:8085 racinfo
```
But if you don't want to use Docker, you can run it with local Node.js installation:
@ -41,20 +41,5 @@ pnpm start --port 8085
## Contributing
If you are a developer of a client, server of development tool for Real Address Chat, you can contribute to Racinfo by adding your tool to the list.
If you are a developer of a client/server/tool for RAC, you can add it to Racinfo by making a pull request.
You can also contribute by improving the documentation or fixing bugs.
**Any pull requests related to adding/updating/removal projects information will be rejected.**
Also, you should get acknowledged with these rules before contributing:
- The project should be related to the Real Address Chat protocol or its successors.
- Your project should have a Git repository or a link to its download page. We do not accept projects that are not hosted on Git or do not provide a download link.
If you want to add your project to the list, please follow these steps:
1. Open an Issue on the [GitHub repository](https://github.com/kostya-zero/racinfo) by using the template **"Add Project"** where you need to replace `Project` with your project name.
2. Attach `add-client`, `add-server` or `add-tool` tag to the issue.
3. Fill the issue template with the information about your tool as described in template.
If you are the author or maintainer of a project already listed in Racinfo, you can also open an issue using the **"Update Project"** template to update your project information.