From 32981ffeb209be57f97624ec6c07960e154c8d7b Mon Sep 17 00:00:00 2001 From: Nolan Lawson Date: Tue, 18 Dec 2018 20:50:30 -0800 Subject: [PATCH] Update README.md [skip ci] --- README.md | 32 ++++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index c379939..b4e9fdd 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@ 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 @@ -24,32 +24,32 @@ Compatible versions of each (Opera, Brave, Samsung, etc.) should be fine. ### Goals - Support the most common use cases -- Fast even on low-end phones -- Works offline in read-only mode +- Small page weight +- Fast even on low-end devices +- Accessibility +- Offline support 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 +### Secondary / possible future goals -- Works as an alternative frontend self-hosted by instances -- Android/iOS apps (using Cordova or similar) -- Support Pleroma/non-Mastodon backends -- i18n +- Support for Pleroma or other non-Mastodon backends +- Serve as an alternative frontend tied to a particular instance +- Support for non-English languages (i18n) - Offline search -- Full emoji keyboard - Keyboard shortcuts ### Non-goals - Supporting old browsers, proxy browsers, or text-based browsers - React Native / NativeScript / hybrid-native version +- Android/iOS apps (using Cordova or similar) - Full functionality with JavaScript disabled - Emoji support beyond the built-in system emoji - Multi-column support - 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 @@ -63,7 +63,7 @@ To build Pinafore for production: ### Docker -To build a docker image for production: +To build a Docker image for production: docker build . docker run -d -p 4002:4002 [your-image] @@ -96,3 +96,7 @@ how to run Pinafore in dev mode and run tests. ## Changelog 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.