Skip to content

Commit

Permalink
Update readme and keywords
Browse files Browse the repository at this point in the history
  • Loading branch information
theodore-s-beers committed Apr 15, 2022
1 parent 3286bc9 commit d00846a
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit d00846a

Please sign in to comment.