Create README.md

README.md

@@ -0,0 +1,28 @@
+---
+library_name: transformers
+tags:
+ - transformers.js
+ - tokenizers
+---
+
+# Grok-1 Tokenizer
+
+A 🤗-compatible version of the **Grok-4 tokenizer** (adapted from [xai-org/grok-1](https://github.com/xai-org/grok-1)). This means it can be used with Hugging Face libraries including [Transformers](https://github.com/huggingface/transformers), [Tokenizers](https://github.com/huggingface/tokenizers), and [Transformers.js](https://github.com/xenova/transformers.js).
+
+## Example usage:
+
+### Transformers/Tokenizers
+```py
+from transformers import LlamaTokenizerFast
+
+tokenizer = LlamaTokenizerFast.from_pretrained('Xenova/grok-1-tokenizer')
+assert tokenizer.encode('hello world') == [21560, 1135]
+```
+
+### Transformers.js
+```js
+import { AutoTokenizer } from '@xenova/transformers';
+
+const tokenizer = await AutoTokenizer.from_pretrained('Xenova/grok-1-tokenizer');
+const tokens = tokenizer.encode('hello world'); // [21560, 1135]
+```