From 59e40b551b76c9b29822a6cd9dcf34198e655a7d Mon Sep 17 00:00:00 2001 From: Danielle McLean Date: Tue, 12 Jun 2018 12:16:18 +1000 Subject: [PATCH] Fix bad indent and a few actual errors in README.md --- README.md | 47 ++++++++++++++++++++++++----------------------- 1 file changed, 24 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 8e532e3..16adb78 100644 --- a/README.md +++ b/README.md @@ -5,27 +5,27 @@ IndieWeb specifications natively. - All content is exposed using standard [microformats2][] markup, making it easy for other sites and applications across the IndieWeb to consume. - Additionally, the site owner's profiles are exposed using [rel-me][], - enabling independent verification of their identity across various services. - This permits [IndieAuth.com][] to authenticate the site's owner using a - social profile, such as a Twitter account. However, this functionality is not - necessary because lemoncurry also fully implements… + enabling independent verification of their identity across various services. + This permits [IndieAuth.com][] to authenticate the site's owner using a + social profile, such as a Twitter account. However, this functionality is not + necessary because lemoncurry also fully implements… - [IndieAuth][], an protocol derived from OAuth 2.0 which enables the site's - owner to authorise access to their domain directly from the lemoncurry site - itself. Additionally, tokens for further access to the lemoncurry site may be - requested and issued, including customisable token scope as in OAuth. + owner to authorise access to their domain directly from the lemoncurry site + itself. Additionally, tokens for further access to the lemoncurry site may be + requested and issued, including customisable token scope as in OAuth. - [Micropub][] is *partially* supported - using a token obtained through - IndieAuth, clients may post new content to the lemoncurry site using either - the form-encoded or JSON request formats. There is currently no support for - updating or deleting existing content through Micropub, although this is of - course planned. + IndieAuth, clients may post new content to the lemoncurry site using either + the form-encoded or JSON request formats. There is currently no support for + updating or deleting existing content through Micropub, although this is of + course planned. - [Webmention][], used to enable rich commenting and social interaction between - separate IndieWeb sites, is partially supported. lemoncurry will correctly - *send* webmentions to all URLs mentioned in a published entry. However, it - currently does not expose an endpoint for *receiving* webmentions. + separate IndieWeb sites, is partially supported. lemoncurry will correctly + *send* webmentions to all URLs mentioned in a published entry. However, it + currently does not expose an endpoint for *receiving* webmentions. - [WebSub][] is also partially supported. When content is posted through - Micropub, WebSub is pinged as it should be - however, since only creating - *new* content through Micropub is supported, updates do not currently cause a - WebSub ping. + Micropub, WebSub is pinged as it should be - however, since only creating + *new* content through Micropub is supported, updates do not currently cause a + WebSub ping. [IndieAuth]: https://www.w3.org/TR/indieauth/ [IndieAuth.com]: https://indieauth.com/ @@ -47,8 +47,8 @@ As well as the following services: * [PostgreSQL][] - create a database named `lemoncurry`. Socket auth is recommended, so ensure the UNIX user you'll be running lemoncurry with has - access to that database. Alternatively, set the `POSTGRES_PASSWORD` - environment variable to use password auth. + access to that database. Alternatively, set the `POSTGRES_PASSWORD` + environment variable to use password auth. * [Redis][] - lemoncurry expects to find Redis on port 6380, rather than the standard port of 6379. Sorry about that. @@ -56,7 +56,7 @@ If you're running in production, I'd recommend [Gunicorn][], which is already pa of lemoncurry's Pipfile. Ensure you run Gunicorn behind a secure reverse proxy, such as [Nginx][]. -If you're running in development, the usual Django `run_server` command should +If you're running in development, the usual Django `runserver` command should be fine. [Gunicorn]: https://gunicorn.org/ @@ -68,12 +68,13 @@ be fine. # Installation -Clone the repo, and then install both Python and Node dependencies: +Clone the repo recursively - since it uses Git submodules - and then install +both Python and Node dependencies. ```shellsession -$ git clone https://git.00dani.me/00dani/lemoncurry +$ git clone --recursive https://git.00dani.me/00dani/lemoncurry $ cd lemoncurry -$ pipenv install +$ pipenv install --dev $ yarn install ```