add user guide and update readme
This commit is contained in:
parent
255ba1a5d5
commit
f54aadaca9
17
README.md
17
README.md
|
@ -1,6 +1,21 @@
|
|||
# Pinafore
|
||||
|
||||
An alternative web client for [Mastodon](https://joinmastodon.org]).
|
||||
An alternative web client for [Mastodon](https://joinmastodon.org]), focused on speed and simplicity.
|
||||
|
||||
Pinafore is available at [pinafore.social](https://pinafore.social).
|
||||
|
||||
For bleeding-edge dev releases, there is also [dev.pinafore.social](https://dev.pinafore.social).
|
||||
|
||||
## Browser support
|
||||
|
||||
Pinafore supports the latest versions of the following browsers:
|
||||
|
||||
- Chrome
|
||||
- Edge
|
||||
- Firefox
|
||||
- Safari
|
||||
|
||||
Compatible versions of each (Opera, Brave, Samsung, etc.) should be fine.
|
||||
|
||||
## Goals and non-goals
|
||||
|
||||
|
|
BIN
docs/Screenshot1.png
Executable file
BIN
docs/Screenshot1.png
Executable file
Binary file not shown.
After Width: | Height: | Size: 331 KiB |
BIN
docs/Screenshot2.png
Executable file
BIN
docs/Screenshot2.png
Executable file
Binary file not shown.
After Width: | Height: | Size: 364 KiB |
BIN
docs/Screenshot3.png
Executable file
BIN
docs/Screenshot3.png
Executable file
Binary file not shown.
After Width: | Height: | Size: 247 KiB |
BIN
docs/Screenshot4.png
Executable file
BIN
docs/Screenshot4.png
Executable file
Binary file not shown.
After Width: | Height: | Size: 200 KiB |
BIN
docs/Screenshot5.png
Executable file
BIN
docs/Screenshot5.png
Executable file
Binary file not shown.
After Width: | Height: | Size: 213 KiB |
BIN
docs/Screenshot6.png
Executable file
BIN
docs/Screenshot6.png
Executable file
Binary file not shown.
After Width: | Height: | Size: 247 KiB |
34
docs/User-Guide.md
Normal file
34
docs/User-Guide.md
Normal file
|
@ -0,0 +1,34 @@
|
|||
This will walk you through the basic usage of Pinafore and its major differences with the Mastodon web UI.
|
||||
|
||||
## Home page
|
||||
|
||||
The home page is both where you write toots and where you read your home timeline:
|
||||
|
||||
![Screenshot of home page](https://github.com/username/repository/blob/master/docs/Screenshot1.png)
|
||||
|
||||
When you scroll down, the "toot" button transforms into a "compose" button:
|
||||
|
||||
![Screenshot showing home page scrolled down](https://github.com/username/repository/blob/master/docs/Screenshot2.png)
|
||||
|
||||
If you press this compose button, you can toot anywhere in your home timeline.
|
||||
|
||||
![Screenshot showing compose box in a modal dialog](https://github.com/username/repository/blob/master/docs/Screenshot3.png)
|
||||
|
||||
## Community page
|
||||
|
||||
By default, the Local Timeline is pinned to the top navigation. In the "Community" section, you can view
|
||||
Lists, the Local Timeline, the Federated Timeline, and your Favorites, and you can also pin any of these to
|
||||
the top navigation.
|
||||
|
||||
![Screenshot of Community page with options to pin multiple timelines](https://github.com/username/repository/blob/master/docs/Screenshot4.png)
|
||||
|
||||
## Multiple instances
|
||||
|
||||
You can manage you instances in the settings:
|
||||
|
||||
![Screenshot of instance settings with a list of instances](https://github.com/username/repository/blob/master/docs/Screenshot5.png)
|
||||
|
||||
For each instance, you can choose a custom theme so that it's easy to
|
||||
remember which instance you're currently using:
|
||||
|
||||
![Screenshot of instance configuration with multiple themes available](https://github.com/username/repository/blob/master/docs/Screenshot6.png)
|
Loading…
Reference in a new issue