Update README

This commit is contained in:
Nat 2023-06-15 08:45:14 -07:00
parent 3d154897a7
commit 93bd08a6a1
Signed by: nat
GPG Key ID: B53AB05285D710D6
1 changed files with 28 additions and 11 deletions

View File

@ -1,18 +1,35 @@
# Hostas # 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 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).
* Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`
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/ Planned protocol support:
* Guides: https://hexdocs.pm/phoenix/overview.html - ActivityPub
* Docs: https://hexdocs.pm/phoenix - Webmentions
* Forum: https://elixirforum.com/c/phoenix-forum
* Source: https://github.com/phoenixframework/phoenix Possible support in the future:
- OStatus
- Zot
- Diaspora
Interfaces:
- Mastodon API
- Misskey and derivatives' API
- Micropub & Microsub