bahai-reflib-data - npm Package Compare versions

Comparing version 0.3.0 to 0.3.1

CHANGES.md

 # CHANGES for `bahai-reflib-data`
 
+## 0.3.1
+
+- docs: disclaimer on individual effort; link to site and server project;
+  move to-dos
+
 ## 0.3.0
@@ -4,0 +9,0 @@

package.json

 {
   "name": "bahai-reflib-data",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "author": "Brett Zamir <[e-mail]>",
@@ -58,3 +58,3 @@ "contributors": [],
   },
-  "readme": "# bahai-reflib-data\n\nThis project aims to host information on the official Bahá'í Reference Library\nwebsite, in particular its unique identifiers, and host scripts for obtaining\nand processing those IDs, such as to map them to paragraph number.\n\nPer <https://bahai-library.com/uhj_additional_tablets_urls>, it seems that the\nURLS hosted on <https://bahai.org/library> may now be permanent, and it is\nhoped that since the paragraphs are not transparent, that the IDs might be\npermanent as well.\n\nOne bit of info: typing <https://bahai.org/r/[ID]> and replacing `[ID]` with\nthe unique ID will redirect to the URL and potentially anchor that it\ntargets.\n\n## Development\n\n1. `npm i -g pnpm` (If you don't have it installed already)\n1. `pnpm i` (Install dependencies)\n1. `pnpm build-data` followed by any of these optional arguments (though\n    choosing at least one):\n    `mainCollections`, `collections`, `works`, `sections`, `paragraphIdInfo` to\n    run the (throttled) downloading and saving of the information\n\n## To-dos\n\n1. Put online as a **JSON service** (using, e.g., for Bahaipedia and Bahai9\n    links)\n1. Put online as a **web app**, allowing a series of pull-downs for work,\n    section, and paragraph number to get the ID and link.\n1. Utilize in restoration of **webextensions**-based Bahá'í Reference Library\n    Wiki Overlay add-on\n\n## Possible to-dos\n\n1. **RSS feed for new additions** to the library (based on a date-detected\n    field)\n"
+  "readme": "# bahai-reflib-data\n\nThis project aims to host information on the official\n[Bahá'í Reference Library](https://bahai.org/library)\nwebsite, in particular its unique identifiers, and host scripts for obtaining\nand processing those IDs, such as to map them to paragraph number.\n\nNote that although this uses data from the Bahá'í Reference Library, this is\njust an individual effort not related to the site.\n\nPer <https://bahai-library.com/uhj_additional_tablets_urls>, it seems that the\nURLS hosted on <https://bahai.org/library> may now be permanent, and it is\nhoped that since the paragraphs are not transparent, that the IDs might be\npermanent as well.\n\nOne bit of info: typing <https://bahai.org/r/[ID]> and replacing `[ID]` with\nthe unique ID will redirect to the URL and potentially anchor that it\ntargets.\n\nA **server** is available via\n[bahai-reflib-data-server](https://github.com/brettz9/bahai-reflib-data-server).\n\n## Development\n\n1. `npm i -g pnpm` (If you don't have it installed already)\n1. `pnpm i` (Install dependencies)\n1. `pnpm build-data` followed by any of these optional arguments (though\n    choosing at least one):\n    `mainCollections`, `collections`, `works`, `sections`, `paragraphIdInfo` to\n    run the (throttled) downloading and saving of the information\n\n## To-dos\n\n1. Utilize in restoration of **webextensions**-based Bahá'í Reference Library\n    Wiki Overlay add-on\n\n## Possible to-dos\n\n1. **RSS feed for new additions** to the library (based on a date-detected\n    field)\n"
 }

README.md

 # bahai-reflib-data
 
-This project aims to host information on the official Bahá'í Reference Library
+This project aims to host information on the official
+[Bahá'í Reference Library](https://bahai.org/library)
 website, in particular its unique identifiers, and host scripts for obtaining
 and processing those IDs, such as to map them to paragraph number.
 
+Note that although this uses data from the Bahá'í Reference Library, this is
+just an individual effort not related to the site.
+
 Per <https://bahai-library.com/uhj_additional_tablets_urls>, it seems that the
@@ -16,2 +20,5 @@ URLS hosted on <https://bahai.org/library> may now be permanent, and it is
 
+A **server** is available via
+[bahai-reflib-data-server](https://github.com/brettz9/bahai-reflib-data-server).
+
 ## Development
@@ -28,6 +35,2 @@
 
-1. Put online as a **JSON service** (using, e.g., for Bahaipedia and Bahai9
-    links)
-1. Put online as a **web app**, allowing a series of pull-downs for work,
-    section, and paragraph number to get the ID and link.
 1. Utilize in restoration of **webextensions**-based Bahá'í Reference Library
@@ -34,0 +37,0 @@ Wiki Overlay add-on

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

7329690

Number of lines in readme file

41

increased by7.89%

No dependency changes