@khitab/core 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.ar.md +6 -3
- package/README.md +4 -2
- package/package.json +1 -1
package/README.ar.md
CHANGED
|
@@ -28,16 +28,19 @@
|
|
|
28
28
|
- **المذكّر ليس محايداً.** اللجوء إلى المذكّر عند الجهل بالجنس حلٌّ عمليٌّ مؤقّت، لا قاعدة صحيحة. نسعى لتقليله كلما سمحت اللغة بصيغةٍ محايدة فعلاً.
|
|
29
29
|
- **اللغة قبل الكود.** أُثَمِّن المساهمة اللغوية أكثر من غيرها؛ القاموس يُبنى بمراجعة لغوية لا بكثرة الالتزامات.
|
|
30
30
|
- **البساطة عقد.** السطح العام صغير ومقصود: دالتان وأربعة أنواع. كل إضافة تُوزَن بميزان الحاجة لا الإمكان.
|
|
31
|
-
- **الشفافية في المراحل.** هذا إصدار alpha (
|
|
31
|
+
- **الشفافية في المراحل.** هذا إصدار alpha (منشور على npm تحت الوسم `alpha`): القاموس مكتمل ومراجَع، لكن المكتبة لم تُختبَر ميدانياً بعد، ونقولها صراحةً بدل أن نوهم باكتمالٍ لم يتحقّق.
|
|
32
32
|
|
|
33
33
|
---
|
|
34
34
|
|
|
35
35
|
## التثبيت
|
|
36
36
|
|
|
37
37
|
```bash
|
|
38
|
-
npm install @khitab/core
|
|
38
|
+
npm install @khitab/core@alpha
|
|
39
39
|
```
|
|
40
40
|
|
|
41
|
+
> الوسم `@alpha` مقصود: المكتبة حالياً في مرحلة alpha، وكتابة `alpha` بيدك إقرارٌ واعٍ منك بذلك. وإن شاء الله عند الوصول إلى الاستقرار يصير التثبيت المجرّد هو الموصى به.
|
|
42
|
+
|
|
43
|
+
|
|
41
44
|
المكتبة بلا أي اعتمادات وقت التشغيل (zero runtime dependencies)، وتأتي بصيغتَي ESM وCJS مع تعريفات أنواع كاملة.
|
|
42
45
|
|
|
43
46
|
---
|
|
@@ -147,7 +150,7 @@ export function handler(req) {
|
|
|
147
150
|
|
|
148
151
|
## ⚠️ تحذير: إصدار alpha
|
|
149
152
|
|
|
150
|
-
هذا إصدار **alpha
|
|
153
|
+
هذا إصدار **alpha** (منشور على npm تحت الوسم `alpha`): القاموس مكتمل ومراجَع، لكن المكتبة لم تُختبَر بعد في مشاريع حقيقية. قد تتغيّر الواجهة العامة (الدوال والأنواع) وقد يتغيّر القاموس (نصوص، إضافات، أسماء مفاتيح) بصورةٍ **غير متوافقة مع السابق** قبل الإصدار المستقر `1.0.0`. إن اعتمدتَ عليه في الإنتاج، **ثبّت إصدارك** (pin) وراجع [سجل التغييرات](./CHANGELOG.md) قبل الترقية.
|
|
151
154
|
|
|
152
155
|
---
|
|
153
156
|
|
package/README.md
CHANGED
|
@@ -24,9 +24,11 @@ It ships 1367 reviewed phrases (780 gendered, 587 naturally neutral) across a co
|
|
|
24
24
|
## Install
|
|
25
25
|
|
|
26
26
|
```bash
|
|
27
|
-
npm install @khitab/core
|
|
27
|
+
npm install @khitab/core@alpha
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
+
> The `@alpha` tag is intentional: the library is currently in its alpha stage, and typing `alpha` yourself is a conscious acknowledgment of that. Once it reaches stability, the plain install will become the recommended one, in shaa' Allah.
|
|
31
|
+
|
|
30
32
|
## Quick start
|
|
31
33
|
|
|
32
34
|
```ts
|
|
@@ -45,7 +47,7 @@ See [`examples/basic.ts`](./examples/basic.ts) for the neutral-fallback and erro
|
|
|
45
47
|
|
|
46
48
|
## ⚠️ Alpha
|
|
47
49
|
|
|
48
|
-
This is an alpha release: the phrase dictionary is complete and reviewed, but the library has not yet been tested in real-world projects.
|
|
50
|
+
This is an alpha release (published to npm under the `alpha` tag): the phrase dictionary is complete and reviewed, but the library has not yet been tested in real-world projects. The API may change before a stable release.
|
|
49
51
|
|
|
50
52
|
## Full documentation
|
|
51
53
|
|
package/package.json
CHANGED