isnady 0.0.1 → 0.0.8

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 Bayram Kotan
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2026 Bayram Kotan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,33 +1,70 @@
-# isnady (JavaScript)
+<h1 align="center">📜 isnady &nbsp;<sub>إسناد</sub></h1>
 
-Hadith search built around the **isnad** — the chain of transmission.
+<p align="center">
+  <strong>Hadith search built around the isnad, the chain of transmission</strong><br>
+  <sub>The JavaScript and TypeScript package</sub>
+</p>
 
-This is the JavaScript/TypeScript package of [isnady](https://github.com/bayramkotan/isnady).
-The desktop application is published on PyPI as `isnady`; both packages will read the
-same SQLite database of hadith, chains, narrators and verdicts.
+<p align="center">
+  <a href="https://www.npmjs.com/package/isnady">
+    <img src="https://img.shields.io/npm/v/isnady?style=for-the-badge&color=14304F&logo=npm&label=npm" alt="npm">
+  </a>
+  <a href="https://pypi.org/project/isnady/">
+    <img src="https://img.shields.io/pypi/v/isnady?style=for-the-badge&color=1D4777&logo=pypi&logoColor=white&label=app%20on%20PyPI" alt="PyPI">
+  </a>
+  <img src="https://img.shields.io/badge/License-MIT-D6B25E?style=for-the-badge" alt="License">
+</p>
 
-> **Status: pre-alpha (0.0.1).** This release only reserves the name and exposes version
-> information. No hadith data is included yet.
+<p align="center">
+  <img src="https://raw.githubusercontent.com/bayramkotan/isnady/main/assets/screenshots/chain.png" alt="The isnady app — the chain of Sahih al-Bukhari 1 from the book to the Prophet" width="780">
+</p>
 
-## Install
+---
 
-```
-npm install isnady
+## 🧭 Where things stand
+
+**isnady** is a hadith search application whose centre is the *isnad*: it reads each
+chain of transmission from the Arabic text, narrator by narrator, and explains what each
+link means. The application runs today on Windows, Linux and macOS:
+
+```bash
+pip install isnady
+iy
 ```
 
+**This npm package is the JavaScript side, and it is not functional yet.** It will be the
+client of the isnady.net web service, which runs the same engine as the application, so a
+chain read on the web and in the app always gives the same answer. Until that service
+exists, the package only reports its version:
+
 ```js
 import { info, version } from "isnady";
-console.log(version);   // "0.0.1"
-console.log(info());
+
+console.log(version); // "0.0.8"
+console.log(info());  // { name: "isnady", version: "0.0.8", dataLoaded: false, homepage: "…" }
+```
+
+TypeScript declarations are included.
+
+## 🗺️ Planned
+
+```js
+import { searchHadith, getChain, getNarrator } from "isnady";
+
+const results = await searchHadith("النيات", { book: "bukhari" });
+const chain   = await getChain("bukhari", 1);      // narrators and the words linking them
+const person  = await getNarrator(chain.links[0]); // biography, teachers, students, verdicts
 ```
 
-## Planned
+Search with Arabic diacritics ignored, chains read narrator by narrator, and grades shown
+exactly as each scholar gave them — the same results as the application.
+
+## 🔗 Links
 
-- `searchHadith(query, options)` — by text, book, narrator and grade
-- `getNarrator(id)` — biography, teachers, students, verdicts, reliability score
-- `getChain(hadithId)` — the isnad, link by link
+- **Application and source:** [github.com/bayramkotan/isnady](https://github.com/bayramkotan/isnady)
+- **Python package:** [pypi.org/project/isnady](https://pypi.org/project/isnady/)
+- **Issues:** [github.com/bayramkotan/isnady/issues](https://github.com/bayramkotan/isnady/issues)
 
-## License
+## 📝 License
 
-MIT for the code. Hadith and narrator data will come from separate sources, each under
-its own license, listed in the main repository as they are added.
+MIT. Hadith data comes from separate sources, each under its own licence.

package/index.d.ts

@@ -1,11 +1,11 @@
-export declare const version: string;
-export declare const name: string;
-
-export interface IsnadyInfo {
-  name: string;
-  version: string;
-  dataLoaded: boolean;
-  homepage: string;
-}
-
-export declare function info(): IsnadyInfo;
+export declare const version: string;
+export declare const name: string;
+
+export interface IsnadyInfo {
+  name: string;
+  version: string;
+  dataLoaded: boolean;
+  homepage: string;
+}
+
+export declare function info(): IsnadyInfo;

package/index.js

@@ -1,12 +1,12 @@
 /**
  * isnady — hadith search built around the isnad.
  *
- * 0.0.1 is a placeholder release: it reserves the package name and exposes
+ * This is a placeholder release: it reserves the package name and exposes
  * version information only. The search API arrives once the shared SQLite
  * database (used by both the Python and JavaScript packages) exists.
  */
 
-export const version = "0.0.1";
+export const version = "0.0.8";
 export const name = "isnady";
 
 /** Returns basic package information. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isnady",
-  "version": "0.0.1",
+  "version": "0.0.8",
   "description": "Hadith search with full isnad chains, narrator biographies, jarh wa ta'dil verdicts and reliability scores",
   "type": "module",
   "main": "./index.js",