memchunk 0.1.0 → 0.1.2
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.md +6 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -9,6 +9,8 @@
|
|
|
9
9
|
</p>
|
|
10
10
|
|
|
11
11
|
<p align="center">
|
|
12
|
+
<a href="https://crates.io/crates/memchunk"><img src="https://img.shields.io/crates/v/memchunk.svg" alt="crates.io"></a>
|
|
13
|
+
<a href="https://pypi.org/project/memchunk"><img src="https://img.shields.io/pypi/v/memchunk.svg" alt="PyPI"></a>
|
|
12
14
|
<a href="https://www.npmjs.com/package/memchunk"><img src="https://img.shields.io/npm/v/memchunk.svg" alt="npm"></a>
|
|
13
15
|
<a href="https://github.com/chonkie-inc/memchunk"><img src="https://img.shields.io/badge/github-memchunk-blue" alt="GitHub"></a>
|
|
14
16
|
<a href="LICENSE-MIT"><img src="https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg" alt="License"></a>
|
|
@@ -22,13 +24,13 @@ you know how every chunking library claims to be fast? yeah, we actually meant i
|
|
|
22
24
|
|
|
23
25
|
want to know how? [read the blog post](https://minha.sh/posts/so-you-want-to-chunk-really-fast) where we nerd out about SIMD instructions and lookup tables.
|
|
24
26
|
|
|
25
|
-
## installation
|
|
27
|
+
## 📦 installation
|
|
26
28
|
|
|
27
29
|
```bash
|
|
28
30
|
npm install memchunk
|
|
29
31
|
```
|
|
30
32
|
|
|
31
|
-
## usage
|
|
33
|
+
## 🚀 usage
|
|
32
34
|
|
|
33
35
|
```javascript
|
|
34
36
|
import { init, chunk } from 'memchunk';
|
|
@@ -64,7 +66,7 @@ const chunks = [...chunk(text)];
|
|
|
64
66
|
|
|
65
67
|
chunks are returned as `Uint8Array` subarrays (zero-copy views of the original text).
|
|
66
68
|
|
|
67
|
-
## citation
|
|
69
|
+
## 📝 citation
|
|
68
70
|
|
|
69
71
|
if you use memchunk in your research, please cite it as follows:
|
|
70
72
|
|
|
@@ -78,6 +80,6 @@ if you use memchunk in your research, please cite it as follows:
|
|
|
78
80
|
}
|
|
79
81
|
```
|
|
80
82
|
|
|
81
|
-
## license
|
|
83
|
+
## 📄 license
|
|
82
84
|
|
|
83
85
|
licensed under either of [Apache License, Version 2.0](LICENSE-APACHE) or [MIT license](LICENSE-MIT) at your option.
|