2018-01-19 06:29:12 +01:00
|
|
|
# Pinafore
|
2018-01-07 00:51:25 +01:00
|
|
|
|
2018-04-02 08:15:52 +02:00
|
|
|
An alternative web client for [Mastodon](https://joinmastodon.org]), focused on speed and simplicity.
|
|
|
|
|
|
2018-04-02 08:18:50 +02:00
|
|
|
Pinafore is available at [pinafore.social](https://pinafore.social). Bleeding-edge releases are at [dev.pinafore.social](https://dev.pinafore.social).
|
2018-04-02 08:15:52 +02:00
|
|
|
|
2018-04-02 08:18:50 +02:00
|
|
|
See the [user guide](https://github.com/nolanlawson/pinafore/blob/master/docs/User-Guide.md) for basic usage.
|
2018-04-02 08:15:52 +02:00
|
|
|
|
|
|
|
|
## 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.
|
2018-02-18 23:38:10 +01:00
|
|
|
|
2018-03-11 20:55:46 +01:00
|
|
|
## Goals and non-goals
|
|
|
|
|
|
|
|
|
|
This section lays out some high-level goals for Pinafore, as well as the goals it _doesn't_ intend to tackle.
|
|
|
|
|
|
|
|
|
|
### Goals
|
|
|
|
|
|
|
|
|
|
- Support the most common use cases
|
|
|
|
|
- Fast even on low-end phones
|
|
|
|
|
- Works offline in read-only mode
|
|
|
|
|
- Progressive Web App features
|
|
|
|
|
- Multi-instance support
|
|
|
|
|
- Support latest versions of Chrome, Edge, Firefox, and Safari
|
|
|
|
|
- a11y (keyboard navigation, screen readers)
|
|
|
|
|
|
|
|
|
|
### Possible future goals
|
|
|
|
|
|
|
|
|
|
- Works as an alternative frontend self-hosted by instances
|
|
|
|
|
- Ship in the Android/iOS app stores as a Cordova app
|
|
|
|
|
- Support Pleroma/non-Mastodon backends
|
|
|
|
|
- i18n
|
2018-03-21 16:39:06 +01:00
|
|
|
- Offline search
|
2018-03-31 02:55:55 +02:00
|
|
|
- Full emoji keyboard
|
2018-04-05 03:33:14 +02:00
|
|
|
- Keyboard shortcuts
|
2018-03-11 20:55:46 +01:00
|
|
|
|
|
|
|
|
### Non-goals
|
|
|
|
|
|
|
|
|
|
- Supporting old browsers, proxy browsers, or text-based browsers
|
|
|
|
|
- React Native / NativeScript / hybrid-native version
|
|
|
|
|
- Full functionality with JavaScript disabled
|
|
|
|
|
- Emoji support beyond the built-in system emoji
|
|
|
|
|
- Multi-column support
|
|
|
|
|
- Admin/moderation panel
|
2018-04-05 03:33:14 +02:00
|
|
|
- Works offline in read-write mode (would require sophisticated sync logic)
|
2018-03-11 20:55:46 +01:00
|
|
|
|
2018-03-31 02:55:55 +02:00
|
|
|
## Building and contributing
|
2018-02-18 23:38:10 +01:00
|
|
|
|
2018-04-05 03:33:14 +02:00
|
|
|
See [CONTRIBUTING.md](https://github.com/nolanlawson/pinafore/blob/master/CONTRIBUTING.md).
|
