From 93bd08a6a1b12cf7345f830d647b2f2167c1f92a Mon Sep 17 00:00:00 2001 From: njms Date: Thu, 15 Jun 2023 08:45:14 -0700 Subject: [PATCH] Update README --- README.md | 39 ++++++++++++++++++++++++++++----------- 1 file changed, 28 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index b2cb07c..c57547e 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,35 @@ # Hostas -To start your Phoenix server: +Hostas is: +- A swiss-army knife of indieweb & federation protocols +- A headless CMS designed to invoke the same developer experience as building a website with a static site generator - * Run `mix setup` to install and setup dependencies - * Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server` +Hostas is very early in development and most of the core functionality has yet to be implemented. The long-term goal is for Hostas to offer optional, native support for a whole bunch of indieweb protocols (primarily ActivityPub and Webmentions, see the roadmap for details). -Now you can visit [`localhost:4000`](http://localhost:4000) from your browser. +## What is "SSG-style website construction?" -Ready to run in production? Please [check our deployment guides](https://hexdocs.pm/phoenix/deployment.html). +* Your unbuilt website is a directory of template files and subdirectories +* Paths from the website's root directory are equivalent to how they're accessed when served (i.e. /path/to/page.eex becomes example.com/path/to/page.html) +* Pages should be entirely static assets as much as possible in this context -## Learn more +## Roadmap +Immediate-term goals: +- Core functionality + * User authentication + * Content streams + * SSG-style website construction +- The "hostapi" native API - * Official website: https://www.phoenixframework.org/ - * Guides: https://hexdocs.pm/phoenix/overview.html - * Docs: https://hexdocs.pm/phoenix - * Forum: https://elixirforum.com/c/phoenix-forum - * Source: https://github.com/phoenixframework/phoenix +Planned protocol support: +- ActivityPub +- Webmentions + +Possible support in the future: +- OStatus +- Zot +- Diaspora + +Interfaces: +- Mastodon API +- Misskey and derivatives' API +- Micropub & Microsub