Skip to content

Commit

Permalink
move readme
Browse files Browse the repository at this point in the history
  • Loading branch information
RaidMax committed Jun 30, 2020
1 parent 6146a7f commit 3e9b0ed
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 35 deletions.
2 changes: 0 additions & 2 deletions IW4MAdmin.Master.pyproj
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ IW4MADMIN_AUTH_KEY=devdevdev</Environment>
<Content Include="src\master\templates\index.html" />
<Content Include="src\master\templates\layout.html" />
<Content Include="src\master\templates\serverlist.html" />
<Content Include="src\README.md" />
</ItemGroup>
<ItemGroup>
<Compile Include="src\master\context\base.py" />
Expand All @@ -71,7 +70,6 @@ IW4MADMIN_AUTH_KEY=devdevdev</Environment>
<Compile Include="src\master\resources\instance.py" />
<Compile Include="src\master\resources\localization.py" />
<Compile Include="src\master\resources\health.py" />
<Compile Include="src\master\resources\server.py" />
<Compile Include="src\master\resources\version.py" />
<Compile Include="src\master\resources\__init__.py" />
<Compile Include="src\master\flask\routes.py" />
Expand Down
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# IW4MAdmin-Master
### Purpose
**IW4MAdmin-Master** is the master list for all running instance of [IW4MAdmin](https://github.com/RaidMax/IW4M-Admin/)
Each **IW4MAdmin** instance sends a heartbeat approximately every 30 seconds which is recieved by this service and stored.
**IW4MAdmin-Master** is also responsible for maintaining the version information and providing current translation strings.

### Requirements
`Python 3.8.x` or newer

### Start (local)
```bash
chmod +x launch.sh
./launch.sh
```

### Endpoints
Unless otherwise specified, all endpoints return JSON
#### /Health
Health status of the master
#### /Instance
All active instances
#### /Version
Current stable and pre-release version
#### /History
Client and server count history
#### /Localization
Latest translation strings

### UI
#### Home
Zoomable plot of servers, client, and instance counts over an interval
#### /servers
Simple list of all server information grouped by game name
33 changes: 0 additions & 33 deletions src/README.md

This file was deleted.

0 comments on commit 3e9b0ed

Please sign in to comment.