Skip to content

Commit ff938d9

Browse files
committed
readme: Add notice about bobashare-admin when downloading release
Also reflow some of the nearby text
1 parent 091a0a7 commit ff938d9

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,19 @@ upload files to an existing instance, see the [Usage
2727

2828
I designed bobashare to be as simple and clean to run as possible. You can
2929
simply run the corresponding `bobashare-web` executable for your platform,
30-
available under [Releases](https://github.com/BBaoVanC/bobashare/releases). It
31-
will create the configured storage directory if it doesn't exist and listen on
32-
the configured address/port. No files on the system are touched outside of the
33-
storage directory.
30+
available under [Releases](https://github.com/BBaoVanC/bobashare/releases).
3431

35-
However, do know that I don't have premade systemd unit service files yet
32+
**Make sure not to accidentally download a `bobashare-admin` executable as it is
33+
just a CLI for interacting with the backend database. It won't run the server.**
34+
35+
bobashare will create the configured storage directory if it doesn't exist and
36+
listen on the configured address/port. No files on the system are touched
37+
outside of the storage directory.
38+
39+
However, do note that I don't have premade systemd unit service files yet
3640
(although writing one will be trivial with how simple it is to run
37-
`bobashare-web`) so running it as a service may be easiest using Docker
38-
(compose).
41+
`bobashare-web`) so running it as a service may currently be easiest using
42+
Docker (and compose).
3943

4044
### Docker
4145

0 commit comments

Comments
 (0)