Browse Source

update docs

Mike 2 years ago
parent
commit
7ad95104b2
2 changed files with 12 additions and 1 deletions
  1. 11 0
      README.md
  2. 1 1
      docs/CLIENT.md

+ 11 - 0
README.md

@@ -1,5 +1,12 @@
 # Retro AIM Server
 
+<div align="center">
+
+<a href="">[![codecov](https://codecov.io/gh/mk6i/retro-aim-server/graph/badge.svg?token=MATKPP77JT)](https://codecov.io/gh/mk6i/retro-aim-server)</a>
+<a href="">![Discord Shield](https://discordapp.com/api/guilds/1238648671348719626/widget.png?style=shield)</a>
+
+</div>
+
 **Retro AIM Server** is an instant messaging server that revives AOL Instant Messenger clients from the 2000s.
 
 <p align="center">
@@ -34,6 +41,10 @@ This project is under active development. Contributions are welcome!
 
 Follow [this guide](./docs/BUILD.md) to learn how to compile and run Retro AIM Server.
 
+## 🌍 Community
+
+Check out the Retro AIM Server [Discord server](https://discord.gg/2Xy4nF3Uh9) to get help or find out how to get involved.
+
 ## 👤 Management API
 
 The Management API provides functionality for administering the server (see [OpenAPI spec](./api.yml)):

+ 1 - 1
docs/CLIENT.md

@@ -44,7 +44,7 @@ Once installed, configure AIM to connect to Retro AIM Server.
       <img width="662" alt="screenshot of AIM preferences window" src="https://github.com/mk6i/mkdb/assets/2894330/c7cfcaa4-8132-4b57-b5c9-7643c99cbda2">
    </p>
 3. In the `Host` field, enter the value of `OSCAR_HOST` found in `config/settings`. In the `Port` field, enter the
-   value of `BOS_PORT` found in `config/settings`.
+   value of `AUTH_PORT` found in `config/settings`.
    <p>
       <img width="618" alt="Screen Shot 2024-03-29 at 11 22 19 PM" src="https://github.com/mk6i/mkdb/assets/2894330/da17c457-a773-4b82-b4ba-cb81f9a2e085">
    </p>