Skip to content

Commit ed4d3b4

Browse files
committed
docs: update README
1 parent 57cca8e commit ed4d3b4

File tree

2 files changed

+34
-53
lines changed

2 files changed

+34
-53
lines changed
File renamed without changes.

README.md

Lines changed: 34 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@
66

77
<p align="center">
88
<i>
9-
Discord bot for managing <a href="https://warframe.fandom.com/wiki/Lunaro">Lunaro</a>
10-
related ideas, targeted at the <a href="https://discord.gg/mUjGHEw">Lunaro Revival Discord Server</a>
9+
Discord bot for managing everything <a href="https://warframe.fandom.com/wiki/Lunaro">Lunaro</a> for the <a href="https://discord.gg/rFBzmpEQxc">Academia Lunaris Discord Server</a>
1110
</i>
1211
</p>
1312

@@ -18,45 +17,21 @@
1817
<a href="LICENSE.md" style="text-decoration: none">
1918
<img src="https://img.shields.io/github/license/imatpot/lunaro-manager?color=blue&style=flat-square">
2019
</a>
20+
<a href="https://discord.gg/rFBzmpEQxc" style="text-decoration: none">
21+
<img src="https://img.shields.io/badge/Join-Academia%20Lunaris-%237289da?logo=discord&style=flat-square">
22+
</a>
2123
</p>
2224

23-
---
24-
25-
## Invite
26-
27-
This bot is readily available in the [Lunaro Revival Discord Server](https://discord.gg/mUjGHEw).
28-
29-
<a href="https://discord.gg/mUjGHEw" style="text-decoration: none">
30-
<img src="https://img.shields.io/badge/Join-Lunaro%20Revival%20Server-%237289da?logo=discord&style=flat-square">
31-
</a>
32-
33-
<br />
34-
35-
In case you want to add this bot to a different server, use the following link:
36-
37-
https://discord.com/api/oauth2/authorize?permissions=277293894656&scope=bot%20applications.commands&client_id=123
38-
39-
while inserting your client ID and keeping the scopes. Remember that the bot is
40-
designed to *only be active in 1 server at a time.*
41-
42-
Please also make sure the bot's personal role is ranked *above* the managed playing role!
43-
44-
---
45-
4625
## Usage
4726

48-
This section explains all functionality which Lunaro Manager offers. Every
49-
action will be replied to with a (selectively ephemeral) message.
50-
5127
### `❓ /help`
5228

53-
Guides to the Discord command explorer to discover all commands, and also links
54-
to this GitHub section.
29+
Guides to the Discord command explorer to discover all commands, and also links to this GitHub section.
5530

5631
### `🏓 /ping`
5732

58-
Check if Lunaro Manager is online and how long it took to receive the ping. This
59-
value is calculated from the system time, and may thus be inaccurate.
33+
Check if Lunaro Manager is online and how long it took to receive the ping.
34+
This value is calculated from the system time, and may thus be inaccurate.
6035

6136
### `🟢 /play now`
6237

@@ -74,23 +49,21 @@ Lists the number of members with the playing role.
7449

7550
### `💤 /tracking pause`
7651

77-
Disables Lunaro tracking for your account. This is useful because the Lunaro
78-
tracker will otherwise override your manually set playing status.
52+
Disables Lunaro tracking for your account.
53+
This is useful because the Lunaro tracker will otherwise override your manually set playing status.
7954

8055
### `👁️ /tracking resume`
8156

82-
Enables Lunaro tracking for your account. Now you don't have to manually set
83-
your playing status anymore.
57+
Enables Lunaro tracking for your account.
58+
Now you don't have to manually set your playing status anymore!
8459

8560
### `💡 /about`
8661

87-
Displays details about Lunaro Manager, including amount of actively tracked
88-
members as well as stats and metadata about the bot.
62+
Displays details about Lunaro Manager, including amount of actively tracked members as well as stats and metadata about the bot.
8963

9064
### `🤝 /contribute`
9165

92-
Displays a link to this GitHub page, encouraging the creation of issues and
93-
pull requests.
66+
Displays a link to this GitHub page, encouraging the creation of issues and pull requests.
9467

9568
---
9669

@@ -100,31 +73,45 @@ pull requests.
10073

10174
2. Enable `PRESENCE` & `SERVER MEMBERS` intents in the Bot section
10275

103-
3. Create a `.env` file following the example of [.env.example](.env.example)
76+
3. Invite the bot to your server, giving the following permissions:
77+
- Manage Roles
78+
- Send Messages
10479

105-
4. Run the bot (see next sections)
80+
4. Create a `.env` file following the schema in [.env.schema](.env.schema)
81+
82+
5. Run the bot using one of the methods below
10683

10784
## Running the bot
10885

86+
You can run the bot in several ways, depending on your preference and use case.
87+
10988
### Run locally
11089

11190
You need to have [Rust](https://rust-lang.org) installed.
91+
This is the recommended way to run the bot during development.
11292

11393
```sh
11494
$ cargo run
11595
```
11696

97+
### Run in Docker
98+
99+
You need to have [Docker](https://docker.com) installed.
100+
This is the recommended way to run the bot in production.
101+
102+
```sh
103+
$ docker compose up --build -d
104+
```
105+
117106
### Run using Nix
118107

119-
If you have the [Nix](https://nixos.org) package manager installed, and enabled
120-
[Flakes](https://nixos.wiki/wiki/Flakes), you have several ways to build and run
121-
this bot.
108+
If you have the [Nix](https://nixos.org) package manager installed with [Flakes](https://nixos.wiki/wiki/Flakes) enabled, you have several ways to build and run this bot.
122109

123110
As a reminder:
124111

125112
- `nix build` builds the package binary
113+
- `nix shell` builds the package binary and makes it available in your `$PATH`
126114
- `nix run` builds the package binary and immediately executes it
127-
- `nix shell` builds the package binary and makes it available in your shell
128115

129116
I will use `nix run` as the example, but you can use any of the above.
130117

@@ -136,11 +123,5 @@ $ nix run
136123
$ nix run github:imatpot/lunaro-manager
137124

138125
# run specific version using remote repository
139-
$ nix run github:imatpot/lunaro-manager/2.0.0
140-
```
141-
142-
### Run in Docker
143-
144-
```sh
145-
$ docker-compose up --build -d
126+
$ nix run github:imatpot/lunaro-manager/2.1.0
146127
```

0 commit comments

Comments
 (0)