make corrections to docs

This commit is contained in:
Hugh Rundle 2020-08-28 21:14:44 +10:00
parent 81db1f167f
commit 275f16e997
2 changed files with 5 additions and 4 deletions

View File

@ -14,7 +14,7 @@ pip3 install ephemetoot
If you do not have permission to install python modules, you may need to use the `--user` flag. Generally this is not advisable, since you will need to run ephemetoot with the same user since it will only be installed for that user and not globally: If you do not have permission to install python modules, you may need to use the `--user` flag. Generally this is not advisable, since you will need to run ephemetoot with the same user since it will only be installed for that user and not globally:
```shell ```shell
pip3 install . --user pip3 install ephemetoot --user
``` ```
## Obtain an access token ## Obtain an access token
@ -27,7 +27,7 @@ Now you've installed `ephemetoot`, in order to actually use it you will need an
4. Enter an application name (e.g. 'ephemetoot'), and give the app both 'read' and 'write' Scopes 4. Enter an application name (e.g. 'ephemetoot'), and give the app both 'read' and 'write' Scopes
5. Click `SUBMIT` 5. Click `SUBMIT`
6. Click on the name of the new app, which should be a link 6. Click on the name of the new app, which should be a link
7. Copy the `Your access token` string 7. Copy the `Your access token` string - you will need this for your configuration file (see below)
**NOTE**: Anyone who has your access token and the domain name of your Mastodon server will be able to: **NOTE**: Anyone who has your access token and the domain name of your Mastodon server will be able to:
* read all your private and direct toots, * read all your private and direct toots,

View File

@ -4,12 +4,13 @@
### Note for users upgrading from Version 2 to Version 3 ### Note for users upgrading from Version 2 to Version 3
To upgrade from Version 2.x to Version 3.x you should be able to simply follow the _Upgrading with pypi_ instructions below. However the safest procedure is: To upgrade from Version 2.x to Version 3.x you will need to remove your existing install.
1. save a copy of your `config.yaml` file somewhere safe 1. save a copy of your `config.yaml` file somewhere safe
2. run `pip uninstall ephemetoot` 2. run `pip uninstall ephemetoot`
3. run `pip install ephemetoot` 3. run `pip install ephemetoot`
4. do a test run with `ephemetoot --test` 4. check your config file is in the current directory
5. do a test run with `ephemetoot --test`
### Upgrading with pypi ### Upgrading with pypi
To upgrade to a new version, the easiest way is to use pip to download the latest version from pypi (remembering that for your machine you may need to substitute `pip` for `pip3`): To upgrade to a new version, the easiest way is to use pip to download the latest version from pypi (remembering that for your machine you may need to substitute `pip` for `pip3`):