From 256f71b4a8f892d2b952d9a0d3f12c9a97ab06bc Mon Sep 17 00:00:00 2001 From: Joe Ardent Date: Sun, 11 Jun 2023 15:53:18 -0700 Subject: [PATCH] more readme formatting --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index a0296cd..3b6b502 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ This is the main repository for USMCP, formerly "Witch Watch", formerly "What2.Watch", etc. etc. USMCP is intended to primarily support the following things as an end user: * keep track of things you want to watch, eg, TV shows, movies, videos, etc. - - including type of thing, whether or not it's private, whether you watched it already, etc. + * including type of thing, whether or not it's private, whether you watched it already, etc. * keep track of people you want to watch those things with * easy to take all your data with you, no lock-in @@ -16,14 +16,14 @@ As an operator, it's meant to be as simple as possible: As a developer, it's meant to be easy to work on: * Pure Rust backend - - [Axum](https://github.com/tokio-rs/axum) with Tokio for async http routing - - [SQLx](https://github.com/launchbadge/sqlx) for talking with the database - - [Askama](https://github.com/djc/askama) for templates - - [Tantivy](https://github.com/quickwit-oss/tantivy) for full and fuzzy text searching (PLANNED) + * [Axum](https://github.com/tokio-rs/axum) with Tokio for async http routing + * [SQLx](https://github.com/launchbadge/sqlx) for talking with the database + * [Askama](https://github.com/djc/askama) for templates + * [Tantivy](https://github.com/quickwit-oss/tantivy) for full and fuzzy text searching (PLANNED) * Simple front end - - currently unstyled hand-written HTML with no javascript! - - barely there! - - a good place for contributing! + * currently unstyled hand-written HTML with no javascript! + * barely there! + * a good place for contributing! ## Overview of the code @@ -60,7 +60,7 @@ The simple modules (that is, ones that are a single file without anything from s exposed to anywhere else outside themselves) are all under `src/`: * `db.rs`: interfacing with sqlite - - (this has an inlined external crate for managing login sessions with sqlite, which takes up most of the lines in the file, but should be considered mostly external) + * (this has an inlined external crate for managing login sessions with sqlite, which takes up most of the lines in the file, but should be considered mostly external) * `generic_handlers.rs`: callback definitions for serving things like redirects to `/` * `login.rs`: error types and handlers for login/logout routes * `signup.rs`: error and response types, and handlers, for signup route @@ -102,7 +102,7 @@ The current development priorities are, in order from most to least important, * finishing the `watches` module, allowing adding things to watch to the system and to your own watchlist * more front-end templates to support the `watches` operations * full-text-search with Tantivy - - realistically, you need this as soon as you can start adding data to it + * realistically, you need this as soon as you can start adding data to it After that, it will be a focus on the front end, and possibly a Flutter/Dart app for mobile. For the web client, I'm leaning toward something like [HTMx](https://htmx.org/docs/#introduction) but am not