Package maintenance (#24)

* Update formating
* npm → pnpm
* move changelog
* update license year
* Add funding
* update docs
* add badges
* Bump packages
* update release workflow
* minify distribution package
* Bump version

.editorconfig

@@ -1,12 +1,12 @@
 root = true
 
 [*]
-indent_style = tab
+indent_style = space
 indent_size = 2
 end_of_line = crlf
 charset = utf-8
 trim_trailing_whitespace = true
-insert_final_newline = true
+insert_final_newline = false
 
 [*.md]
 trim_trailing_whitespace = false

.github/FUNDING.yml

@@ -0,0 +1 @@
+ko_fi: branosandala

.github/workflows/npm-publish.yml

@@ -1,7 +1,4 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
-
-name: Node.js Package
+name: Publish NPM Package
 
 on:
   release:
@@ -14,8 +11,8 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
-          node-version: 12
-      - run: npm ci
+          node-version: 18
+      - run: npm install
       - run: npm test
 
   publish-npm:
@@ -25,9 +22,9 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
-          node-version: 12
+          node-version: 18
           registry-url: https://registry.npmjs.org/
-      - run: npm ci
+      - run: npm install
       - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

docs/CHANGELOG.md → CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog for Rusyn transliterate
 
+## 2.1.1 // 2024-12-01
+
+### 🔨 Maintenance
+- Change packaging from NPM to PNPM 
+- Update packages to their latest versions
+- Tidy up the project structure
+- Update publishing workflow
+- Limit the NPM package to `dist/translit_dist.min.js` only
+
+
 ## 2.1.0 // 2022-09-07
 This version is a bigger improvement since 2020. Translit now works well for UPPER CASE texts and works better for numerous combinations of soft (я, є, ї, ё, ю) and hard (а, е, і, о, у, и, ы, ї) vowels.
 

LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-22 Branislav Šandala
+Copyright (c) 2014-24 Branislav Šandala
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,9 +1,11 @@
 # translit — Rusyn transliteration
 
-Rusyn language is written in Cyrillic script. If you lack a proper keyboard or an extra software, writing in Rusyn can take a while.
+![GitHub package.json version](https://img.shields.io/github/package-json/v/surfinzap/translit?color=7b00cb&style=flat)
+![GitHub](https://img.shields.io/github/license/surfinzap/translit?color=7b00cb&style=flat)
 
-Translit is a javascript library to transliterate Rusyn language from Latin alphabet to Cyrillic script and vice versa. You can write your text in Latin alphabet and then transliterate it automatically.
+The Rusyn language is written in the Cyrillic script, which can be challenging to type if you don’t have the right keyboard or software.
 
+That’s where Translit comes in—a JavaScript library designed to easily transliterate Rusyn text between the Latin alphabet and Cyrillic script. Simply type in Latin letters, and Translit will convert your text to Cyrillic (or the other way around) instantly.
 
 ## Use
 
@@ -18,24 +20,28 @@ npm install translit-rue
 ```
 
 ### JS library
-* Download dist/translit.min.js and include it in your web project.
+Download `dist/translit.min.js` and include it in your web project.
 
 
 ## Documentation
-Transliterate text from Cyrillic script to Latin alphabet:
+Transliterate a text from the Cyrillic script to the Latin alphabet:
 ```javascript
 translitCyrLat(string)
 ```
 
-Transliterate text from Latin alphabet to Cyrillic script:
+Transliterate a text from the Latin alphabet to the Cyrillic script:
 ```javascript
 translitLatCyr(string)
 ```
 
 
+## Support & Feedback
+If you like Translit, [buy me a coffee](https://ko-fi.com/branosandala) to keep the project running.
+
+
 ## License
 Licensed under MIT license. (See [LICENCE.TXT](//github.com/surfinzap/translit/blob/master/LICENSE.txt).)
 
 
 ## Special thanks
-* [@vit-svoboda](https://github.com/vit-svoboda) for a help with gulp pipeline (2.0.0)
+- [@vit-svoboda](https://github.com/vit-svoboda) for a help with gulp pipeline (2.0.0)