data.coop/pinafore
8
0
Fork 0
Code Issues 1 Pull requests Packages Projects Releases Wiki Activity

Update README.md

Browse source 
[skip ci]
This commit is contained in:
Nolan Lawson 2018-12-18 20:50:30 -08:00 committed by GitHub
parent d047a265a3
commit 32981ffeb2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -2,11 +2,11 @@
An alternative web client for [Mastodon](https://joinmastodon.org), focused on speed and simplicity. An alternative web client for [Mastodon](https://joinmastodon.org), focused on speed and simplicity.
Pinafore is available at [pinafore.social](https://pinafore.social). Bleeding-edge releases are at [dev.pinafore.social](https://dev.pinafore.social). Pinafore is available at [pinafore.social](https://pinafore.social). Beta releases are at [dev.pinafore.social](https://dev.pinafore.social).
See the [user guide](https://github.com/nolanlawson/pinafore/blob/master/docs/User-Guide.md) for basic usage. See the [admin guide](https://github.com/nolanlawson/pinafore/blob/master/docs/Admin-Guide.md) to troubleshoot instance compatibility issues. See the [user guide](https://github.com/nolanlawson/pinafore/blob/master/docs/User-Guide.md) for basic usage. See the [admin guide](https://github.com/nolanlawson/pinafore/blob/master/docs/Admin-Guide.md) if Pinafore cannot connect to your instance.
For updates and support, follow us at [@pinafore@mastodon.technology](https://mastodon.technology/@pinafore). For updates and support, follow [@pinafore@mastodon.technology](https://mastodon.technology/@pinafore).
## Browser support ## Browser support
@ -24,32 +24,32 @@ Compatible versions of each (Opera, Brave, Samsung, etc.) should be fine.
### Goals ### Goals
- Support the most common use cases - Support the most common use cases
- Fast even on low-end phones - Small page weight
- Works offline in read-only mode - Fast even on low-end devices
- Accessibility
- Offline support in read-only mode
- Progressive Web App features - Progressive Web App features
- Multi-instance support - Multi-instance support
- Support latest versions of Chrome, Edge, Firefox, and Safari - Support latest versions of Chrome, Edge, Firefox, and Safari
- a11y (keyboard navigation, screen readers)
### Possible future goals ### Secondary / possible future goals
- Works as an alternative frontend self-hosted by instances - Support for Pleroma or other non-Mastodon backends
- Android/iOS apps (using Cordova or similar) - Serve as an alternative frontend tied to a particular instance
- Support Pleroma/non-Mastodon backends - Support for non-English languages (i18n)
- i18n
- Offline search - Offline search
- Full emoji keyboard
- Keyboard shortcuts - Keyboard shortcuts
### Non-goals ### Non-goals
- Supporting old browsers, proxy browsers, or text-based browsers - Supporting old browsers, proxy browsers, or text-based browsers
- React Native / NativeScript / hybrid-native version - React Native / NativeScript / hybrid-native version
- Android/iOS apps (using Cordova or similar)
- Full functionality with JavaScript disabled - Full functionality with JavaScript disabled
- Emoji support beyond the built-in system emoji - Emoji support beyond the built-in system emoji
- Multi-column support - Multi-column support
- Admin/moderation panel - Admin/moderation panel
- Works offline in read-write mode (would require sophisticated sync logic) - Offline support in read-write mode (would require sophisticated sync logic)
## Building ## Building
@ -63,7 +63,7 @@ To build Pinafore for production:
### Docker ### Docker
To build a docker image for production: To build a Docker image for production:
docker build . docker build .
docker run -d -p 4002:4002 [your-image] docker run -d -p 4002:4002 [your-image]
@ -96,3 +96,7 @@ how to run Pinafore in dev mode and run tests.
## Changelog ## Changelog
For a changelog, see the [GitHub releases](http://github.com/nolanlawson/pinafore/releases/). For a changelog, see the [GitHub releases](http://github.com/nolanlawson/pinafore/releases/).
## What's with the name?
Pinafore is named after the [Gilbert and Sullivan play](https://en.wikipedia.org/wiki/Hms_pinafore). The [soundtrack](https://www.allmusic.com/album/gilbert-sullivan-hms-pinafore-1949-mw0001830483) is very good.