Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README update chapter fix / additions to commands list #112

Merged
merged 4 commits into from
Jun 14, 2023
Merged

README update chapter fix / additions to commands list #112

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
38f97d2
Fix notes in README update-chapter
JOJ0 Jun 14, 2023
69a9bf9
Add proposal for statistics commands to README
JOJ0 Jun 14, 2023
6cbb526
Update README.md
JOJ0 Jun 14, 2023
77649ce
Update README.md
JOJ0 Jun 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,9 +208,9 @@ git pull
pip install .
```

*Note: If you installed to a Python venv, first load it as described in [install to virtual environment](#install-to-virtual-environment).*
*Note: If you've installed to a Python venv, [activate it](CONTRIBUTING.md#3-set-up-a-python3-virtual-environment).*
JOJ0 marked this conversation as resolved.
Show resolved Hide resolved

*Note: If you installed in [development mode](#install-in-development-mode) you can spare the `pip install .` command - just `git pull` and you're done.*
*Note: If you've installed in [editable mode](CONTRIBUTING.md#4-install-in-editable-mode) you can spare the `pip install .` command - just `git pull` and you're done.*
JOJ0 marked this conversation as resolved.
Show resolved Hide resolved



Expand Down Expand Up @@ -257,6 +257,8 @@ pip install .
* [x] [Server Notices](https://matrix-org.github.io/synapse/develop/admin_api/server_notices.html)
* [x] ~~[Shutdown Room](https://matrix-org.github.io/synapse/develop/admin_api/shutdown_room.html)~~ (DEPRECATED, covered by `room delete`)
* [ ] [Statistics](https://matrix-org.github.io/synapse/develop/admin_api/statistics.html)
* [ ] `synadm media user-stats`
* [ ] `synadm room largest`
* [x] [Users](https://matrix-org.github.io/synapse/develop/admin_api/user_admin_api.html)
* [x] `user details <user id>`
* [x] `user modify <user id>` (also used for user creation)
Expand Down Expand Up @@ -285,7 +287,7 @@ pip install .

## Get in Touch

If you need avice on using synadm, have a feature idea or would like to discuss anything else around `synadm`, get in touch via Matrix!
If you need advice on using synadm, have a feature idea or would like to discuss anything else around `synadm`, get in touch via Matrix!

We are hanging around in the official support room for Synapse, [#synapse:matrix.org](https://matrix.to/#/#synapse:matrix.org). Usually you'll find `synadm` users there that might answer your questions already. If not, mentioning `synadm` will ping us with the help of Element's keyword notify feature and we'll try to get in touch.

Expand Down