Merge pull request #190 from openzim/various-small-improvements

Various small improvements

Author: kelson42

.github/workflows/publish.yml

@@ -1,9 +1,8 @@
 name: Publish
 
 on:
-  push:
-    tags:
-      - 'v?[0-9]+.[0-9]+.[0-9]+'
+  release:
+    types: [published]
 
 jobs:
   build:
@@ -16,10 +15,6 @@ jobs:
           node-version: "18.x"
           registry-url: "https://registry.npmjs.org"
 
-      - name: Check if tag is created on default branch
-        if: endsWith(github.event.base_ref, '/main') == false
-        run: echo "Please create the tag on default branch" && exit -1
-
       - run: npm ci
       - run: npm publish
         env:

Changelog

@@ -1,5 +1,5 @@
 2.4.0:
-* NEW Full localization of the ZIM files (@pavel-karatsiuba #178)
+* NEW Full localization system (still no translations) (@pavel-karatsiuba #178)
 * NEW Harmonisation of the logo (@pavel-karatsiuba #177)
 * FIX Many CSS odities (@pavel-karatsiuba #178)
 * FIX Broken favicon links (@pavel-karatsiuba #175)

README.md

@@ -1,16 +1,25 @@
+# PhET Simulations scraper
+
+This scraper creates offline versions in [ZIM
+format](https://openzim.org) of [PhET science
+simulations for Science and Math](https://phet.colorado.edu).
+
 <a href="https://play.google.com/store/apps/details?id=org.kiwix.kiwixcustomphet" target="_blank" align="left">
   <img src="https://play.google.com/intl/en/badges/images/badge_new.png" alt="Get it on Google Play" height="30" />
 </a>
 
-# PhET Simulations scraper
+[![npm](https://nodei.co/npm/phetscraper.png)](https://www.npmjs.com/package/phetscraper)
 
-This scraper creates offline versions in [ZIM
-format](https://openzim.org) of [PhET science
-simulations](https://phet.colorado.edu) in the ZIM format.
+[![npm](https://img.shields.io/npm/v/phetscraper.svg)](https://www.npmjs.com/package/phetscraper)
+[![Docker Image](https://img.shields.io/docker/v/openzim/phet?arch=amd64&label=docker&sort=semver)](https://hub.docker.com/r/openzim/phet)
+[![CI](https://github.com/openzim/phet/actions/workflows/ci.yml/badge.svg)](https://github.com/openzim/phet/actions/workflows/ci.yml)
+[![CodeFactor](https://www.codefactor.io/repository/github/openzim/phet/badge)](https://www.codefactor.io/repository/github/openzim/phet)
+[![Latest ZIM releases](https://img.shields.io/badge/latest-ZIM-%23ff4365)](https://download.kiwix.org/zim/phet/)
+[![License](https://img.shields.io/npm/l/phetscraper.svg)](LICENSE)
 
 ## Requirements
 
-It requires Node.js v16 or higher.
+It requires Node.js version 16 or higher.
 
 ## Quick Start
 
@@ -20,14 +29,6 @@ npm i && npm start
 
 The above will eventually output a ZIM file to ```dist/```
 
-[![NPM](https://nodei.co/npm/phetscraper.png)](https://www.npmjs.com/package/phetscraper)
-
-[![npm](https://img.shields.io/npm/v/phetscraper.svg)](https://www.npmjs.com/package/phetscraper)
-[![CI](https://github.com/openzim/phet/actions/workflows/ci.yml/badge.svg)](https://github.com/openzim/phet/actions/workflows/ci.yml)
-[![Docker Image](https://img.shields.io/docker/v/openzim/phet?arch=amd64&label=docker&sort=semver)](https://hub.docker.com/r/openzim/phet)
-[![Latest ZIM releases](https://img.shields.io/badge/latest-ZIM-%23ff4365)](https://download.kiwix.org/zim/phet/)
-[![CodeFactor](https://www.codefactor.io/repository/github/openzim/phet/badge)](https://www.codefactor.io/repository/github/openzim/phet)
-
 ## Command line arguments
 Available on GET and EXPORT steps only:
 ```bash
@@ -43,7 +44,7 @@ Available on EXPORT step only:
 
 Example:
 ```bash
-npm run get -- --includeLanguages en ru fr`
+npm run get -- --includeLanguages en ru fr
 ```
 
 ## Config
@@ -65,7 +66,7 @@ PHET_VERBOSE_ERRORS=false
 This project achieves multiple things:
 * Download PhET content
 * Generate an Index for said content
-* Generate a ZIM file containing content and index
+* Generate ZIM file(s) containing content and index
 
 Things this project does not yet do, but should:
 * Generate Android APK
@@ -83,3 +84,9 @@ The steps get, transform and export have their own output directories:
 * ```get``` outputs HTML and PNG files to ```state/get```
 * ```transform``` outputs intermediate files to ```state/transform```
 * ```export``` outputs HTML and PNG files to ```state/export``` AND a ZIM file(s) to ```dist/```
+
+License
+-------
+
+[Apache](https://www.apache.org/licenses/LICENSE-2.0) or later, see
+[LICENSE](LICENSE) for more details.