From d00846ad5ce9a8ea5de5608f117104e756f6cf65 Mon Sep 17 00:00:00 2001 From: Theo Beers <32523293+theodore-s-beers@users.noreply.github.com> Date: Fri, 15 Apr 2022 22:53:43 +0200 Subject: [PATCH] Update readme and keywords --- Cargo.toml | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 1e6e129..1fc67cd 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -5,7 +5,7 @@ edition = "2021" license = "MIT" description = "Pretty-print a poem from Ganjoor" repository = "https://github.com/theodore-s-beers/ganjoor-pretty" -keywords = ["formatting", "ganjoor", "Persian", "poem"] +keywords = ["typesetting", "Ganjoor", "Persian", "poem"] categories = ["internationalization", "template-engine", "text-processing"] [dependencies] diff --git a/README.md b/README.md index 988d68f..44de6fc 100644 --- a/README.md +++ b/README.md @@ -10,4 +10,4 @@ _NB: This is the successor to an earlier mini-project, [ghazal-typesetting](http ## Technical notes -This is basically a little Rust application, built with [Actix Web](https://actix.rs/). It takes a Ganjoor URL, fetches and parses the relevant contents of the page (using the [isahc](https://github.com/sagebind/isahc) and [scraper](https://github.com/causal-agent/scraper) crates), and constructs a new HTML document with [Pandoc](https://github.com/jgm/pandoc)—which is a required external dependency. Note that we're asking Pandoc to bundle in `head.html` and `script.html`, which in turn reference `styles.css` and `pretty.js`. So those files also need to be present. The application listens on localhost port 5779 (chosen at random) and can be put on a server behind a reverse proxy, with a CDN for caching, etc. Pretty straightforward. +This is basically a little Rust application, built with [Actix Web](https://actix.rs/). It takes a Ganjoor URL, fetches the relevant poem through their API (using the [isahc](https://github.com/sagebind/isahc) crate), and constructs a new HTML document with [Pandoc](https://github.com/jgm/pandoc)—which is a required external dependency. Note that we're asking Pandoc to bundle in `head.html` and `script.html`, which in turn reference `styles.css` and `pretty.js`. So those files also need to be present. The application listens on localhost port 5779 (chosen at random to avoid conflicts) and can be put on a server behind a reverse proxy, with a CDN for caching, etc. Pretty straightforward.