Merge pull request #15 from bperel/freshen-up

Freshen up

Author: bperel

.eslintrc.json

@@ -0,0 +1,9 @@
+{
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": 12,
+        "sourceType": "module"
+      },
+      "plugins": ["@typescript-eslint"],
+      "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended", "prettier"] 
+}

Dockerfile

@@ -1,9 +1,9 @@
-FROM node:10-buster-slim
+FROM node:16-slim
 
 WORKDIR /home/wiki-as-git
-COPY package.json package-lock.json wiki-as-git.js ./
+COPY package.json package-lock.json tsconfig.json wiki-as-git.ts ./
 
-RUN apt-get update && apt-get install -y --no-install-recommends libgit2-dev git && apt-get clean \
- && npm rebuild && npm install
+RUN apt-get update && apt-get install -y --no-install-recommends git && apt-get clean
+RUN npm install
 
-ENTRYPOINT ["/home/wiki-as-git/wiki-as-git.js"]
+ENTRYPOINT ["./node_modules/.bin/ts-node", "wiki-as-git.ts"]

README.md

@@ -6,16 +6,26 @@ An easy way to check the revision history of a Wikipedia article using Git comma
 
 # Install
 
-* You can run wiki-as-git using our Docker image :
-`docker run --rm -it -v $(pwd)/articles:/home/wiki-as-git/articles bperel/wiki-as-git "Hello world"`
+* You can run wiki-as-git using our Docker image, see Usage.
 
-* Or you can install it manually :
-  * `libgit2-dev` is required for the `nodegit` dependency.
-  * Then run `npm rebuild && npm install`
+* Or you can install its dependencies manually : `npm install`
 
 ## Usage
 
-`wiki-as-git.js [--language=en] "<Article name>"`
+### With Docker, using a pre-built image
+
+`docker run --rm -it -v $(pwd)/articles:/home/wiki-as-git/articles bperel/wiki-as-git '<Article name>'`
+
+Example:
+`docker run --rm -it -v $(pwd)/articles:/home/wiki-as-git/articles bperel/wiki-as-git '"Hello, World!" program'`
+
+### Without Docker
+
+`npx ts-node wiki-as-git.ts [--language=en] '<Article name>'`
+
+Example:
+`npx ts-node wiki-as-git.ts '"Hello, World!" program'`
+
 
 If you have bot credentials for the wiki that you wish to target, copy-paste `settings.example.json` into a file named `settings.json` and fill in the bot's credentials.
 This will lift some limits of the Mediawiki API and make wiki-as-git much faster.