pinafore/README.md

41 lines
1.1 KiB
Markdown
Raw Normal View History

2018-01-19 05:29:12 +00:00
# Pinafore
2018-01-06 23:51:25 +00:00
2018-02-18 22:38:10 +00:00
An alternative web client for [Mastodon](https://joinmastodon.org]).
2018-03-11 19:55:46 +00: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 15:39:06 +00:00
- Offline search
2018-03-31 00:55:55 +00:00
- Full emoji keyboard
2018-03-11 19:55:46 +00: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
- Keyboard shortcuts
- Admin/moderation panel
- Works offline in read-write mode
2018-03-31 00:55:55 +00:00
## Building and contributing
2018-02-18 22:38:10 +00:00
2018-03-31 00:55:55 +00:00
See [CONTRIBUTING.md](https://github.com/nolanlawson/pinafore/blob/master/CONTRIBUTING.md).