Pinafore-Web-Client-Frontend/docs/User-Guide.md

40 lines
1.7 KiB
Markdown

# Pinafore user guide
This will walk you through the basic usage of Pinafore and its major differences with the Mastodon web UI.
* [Home page](#home-page)
* [Community page](#community-page)
* [Multiple instances](#multiple-instances)
## 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/nolanlawson/pinafore/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/nolanlawson/pinafore/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/nolanlawson/pinafore/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/nolanlawson/pinafore/blob/master/docs/Screenshot4.png)
## Multiple instances
You can manage your instances in the settings:
![Screenshot of instance settings with a list of instances](https://github.com/nolanlawson/pinafore/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/nolanlawson/pinafore/blob/master/docs/Screenshot6.png)