diff --git a/README.md b/README.md index 1fee59d9..68fdb437 100644 --- a/README.md +++ b/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 diff --git a/docs/Screenshot1.png b/docs/Screenshot1.png new file mode 100755 index 00000000..40d37892 Binary files /dev/null and b/docs/Screenshot1.png differ diff --git a/docs/Screenshot2.png b/docs/Screenshot2.png new file mode 100755 index 00000000..c9b2adc8 Binary files /dev/null and b/docs/Screenshot2.png differ diff --git a/docs/Screenshot3.png b/docs/Screenshot3.png new file mode 100755 index 00000000..5bf6fe3a Binary files /dev/null and b/docs/Screenshot3.png differ diff --git a/docs/Screenshot4.png b/docs/Screenshot4.png new file mode 100755 index 00000000..ab028ba3 Binary files /dev/null and b/docs/Screenshot4.png differ diff --git a/docs/Screenshot5.png b/docs/Screenshot5.png new file mode 100755 index 00000000..812da373 Binary files /dev/null and b/docs/Screenshot5.png differ diff --git a/docs/Screenshot6.png b/docs/Screenshot6.png new file mode 100755 index 00000000..1ba46011 Binary files /dev/null and b/docs/Screenshot6.png differ diff --git a/docs/User-Guide.md b/docs/User-Guide.md new file mode 100644 index 00000000..dfa66b43 --- /dev/null +++ b/docs/User-Guide.md @@ -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) \ No newline at end of file