From 0c228d69d7db4d366e030947c95859fedb5f1a31 Mon Sep 17 00:00:00 2001 From: gardenapple Date: Mon, 25 Jan 2021 22:13:02 +0200 Subject: [PATCH] Localization READMEs --- README.md | 6 +++++- locales/README.md | 5 +++++ 2 files changed, 10 insertions(+), 1 deletion(-) create mode 100644 locales/README.md diff --git a/README.md b/README.md index cf7011e..79e0502 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,10 @@ See `readable --help` for more information. It's a good idea to supply the --base parameter when piping input, otherwise `readable` won't know the document's URL, and things like relative links won't work. -### Why Node.js? It's so slow! +## Localization + +See [locales](locales). + +## Why Node.js? It's so slow! I know that it's slow, but JavaScript is the most sensible option for this, since Mozilla's Readabilty library is written in JavaScript. [There have been ports of the Readability algorithm to other languages](https://github.com/masukomi/arc90-readability), but Mozilla's version is the only one that's actively maintained as of 2020. diff --git a/locales/README.md b/locales/README.md new file mode 100644 index 0000000..7bdb65e --- /dev/null +++ b/locales/README.md @@ -0,0 +1,5 @@ +## Localization + +Localization is done via .json files. Keys are in English and values are in your preferred language. + +Please try to preserve formatting, and check to see if the output looks good on a 120 chars wide terminal.