@asciirender/asciir 1.0.2 → 1.0.3
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 +21 -21
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
# ASCIIR
|
|
2
2
|
|
|
3
3
|
<p align="center">
|
|
4
|
-
<img src="https://img.shields.io/npm/v/asciir?color=blue&label=npm" alt="npm version" />
|
|
5
|
-
<img src="https://img.shields.io/npm/dm/asciir?color=green" alt="npm downloads" />
|
|
6
|
-
<img src="https://img.shields.io/bundlephobia/minzip/asciir?color=orange" alt="bundle size" />
|
|
7
|
-
<img src="https://img.shields.io/github/license/
|
|
8
|
-
<img src="https://img.shields.io/npm/types/asciir?color=blue" alt="TypeScript" />
|
|
4
|
+
<img src="https://img.shields.io/npm/v/@asciirender/asciir?color=blue&label=npm" alt="npm version" />
|
|
5
|
+
<img src="https://img.shields.io/npm/dm/@asciirender/asciir?color=green" alt="npm downloads" />
|
|
6
|
+
<img src="https://img.shields.io/bundlephobia/minzip/@asciirender/asciir?color=orange" alt="bundle size" />
|
|
7
|
+
<img src="https://img.shields.io/github/license/ASCIIRenderer/ASCIIR?color=purple" alt="license" />
|
|
8
|
+
<img src="https://img.shields.io/npm/types/@asciirender/asciir?color=blue" alt="TypeScript" />
|
|
9
9
|
</p>
|
|
10
10
|
|
|
11
11
|
<p align="center">
|
|
@@ -13,10 +13,10 @@
|
|
|
13
13
|
</p>
|
|
14
14
|
|
|
15
15
|
<p align="center">
|
|
16
|
-
<a href="
|
|
17
|
-
<a href="
|
|
18
|
-
<a href="
|
|
19
|
-
<a href="
|
|
16
|
+
<a href="#-installation">Installation</a> •
|
|
17
|
+
<a href="#-quick-start">Quick Start</a> •
|
|
18
|
+
<a href="#-api-reference">API</a> •
|
|
19
|
+
<a href="#-examples">Examples</a>
|
|
20
20
|
</p>
|
|
21
21
|
|
|
22
22
|
---
|
|
@@ -35,21 +35,21 @@
|
|
|
35
35
|
## 📦 Installation
|
|
36
36
|
|
|
37
37
|
```bash
|
|
38
|
-
npm install asciir
|
|
38
|
+
npm install @asciirender/asciir
|
|
39
39
|
```
|
|
40
40
|
|
|
41
41
|
```bash
|
|
42
|
-
yarn add asciir
|
|
42
|
+
yarn add @asciirender/asciir
|
|
43
43
|
```
|
|
44
44
|
|
|
45
45
|
```bash
|
|
46
|
-
pnpm add asciir
|
|
46
|
+
pnpm add @asciirender/asciir
|
|
47
47
|
```
|
|
48
48
|
|
|
49
49
|
## 🚀 Quick Start
|
|
50
50
|
|
|
51
51
|
```tsx
|
|
52
|
-
import { ASCIIR } from 'asciir';
|
|
52
|
+
import { ASCIIR } from '@asciirender/asciir';
|
|
53
53
|
|
|
54
54
|
function App() {
|
|
55
55
|
return (
|
|
@@ -71,7 +71,7 @@ function App() {
|
|
|
71
71
|
The main component for rendering ASCII art.
|
|
72
72
|
|
|
73
73
|
```tsx
|
|
74
|
-
import { ASCIIR, useASCIIRender } from 'asciir';
|
|
74
|
+
import { ASCIIR, useASCIIRender } from '@asciirender/asciir';
|
|
75
75
|
|
|
76
76
|
function App() {
|
|
77
77
|
const asciiRef = useASCIIRender();
|
|
@@ -156,7 +156,7 @@ import {
|
|
|
156
156
|
CHAR_SETS, // Character set presets
|
|
157
157
|
FONTS, // Font presets
|
|
158
158
|
PALETTE_PRESETS // Color palette presets
|
|
159
|
-
} from 'asciir';
|
|
159
|
+
} from '@asciirender/asciir';
|
|
160
160
|
|
|
161
161
|
// Character sets
|
|
162
162
|
CHAR_SETS.default // " .:-=+*#%@"
|
|
@@ -187,7 +187,7 @@ import {
|
|
|
187
187
|
generateSVG,
|
|
188
188
|
generateHTML,
|
|
189
189
|
loadImage
|
|
190
|
-
} from 'asciir';
|
|
190
|
+
} from '@asciirender/asciir';
|
|
191
191
|
|
|
192
192
|
// Load and process an image
|
|
193
193
|
const img = await loadImage('/path/to/image.jpg');
|
|
@@ -222,7 +222,7 @@ const canvas = generateCanvasFromAscii(result, config, 2);
|
|
|
222
222
|
### Custom Palette
|
|
223
223
|
|
|
224
224
|
```tsx
|
|
225
|
-
import { ASCIIR, PALETTE_PRESETS } from 'asciir';
|
|
225
|
+
import { ASCIIR, PALETTE_PRESETS } from '@asciirender/asciir';
|
|
226
226
|
|
|
227
227
|
<ASCIIR
|
|
228
228
|
src="/image.jpg"
|
|
@@ -236,7 +236,7 @@ import { ASCIIR, PALETTE_PRESETS } from 'asciir';
|
|
|
236
236
|
### With Downloads
|
|
237
237
|
|
|
238
238
|
```tsx
|
|
239
|
-
import { ASCIIR, useASCIIRender } from 'asciir';
|
|
239
|
+
import { ASCIIR, useASCIIRender } from '@asciirender/asciir';
|
|
240
240
|
|
|
241
241
|
function App() {
|
|
242
242
|
const ref = useASCIIRender();
|
|
@@ -256,7 +256,7 @@ function App() {
|
|
|
256
256
|
|
|
257
257
|
```tsx
|
|
258
258
|
import { useState } from 'react';
|
|
259
|
-
import { ASCIIR } from 'asciir';
|
|
259
|
+
import { ASCIIR } from '@asciirender/asciir';
|
|
260
260
|
|
|
261
261
|
function App() {
|
|
262
262
|
const [file, setFile] = useState<File | null>(null);
|
|
@@ -278,8 +278,8 @@ function App() {
|
|
|
278
278
|
|
|
279
279
|
```bash
|
|
280
280
|
# Clone the repository
|
|
281
|
-
git clone https://github.com/
|
|
282
|
-
cd
|
|
281
|
+
git clone https://github.com/ASCIIRenderer/ASCIIR.git
|
|
282
|
+
cd ASCIIR
|
|
283
283
|
|
|
284
284
|
# Install dependencies
|
|
285
285
|
npm install
|
package/package.json
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@asciirender/asciir",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.3",
|
|
4
4
|
"description": "A powerful React component for converting images to beautiful ASCII art with customizable settings",
|
|
5
5
|
"author": "dvinay",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"repository": {
|
|
8
8
|
"type": "git",
|
|
9
|
-
"url": "git+https://github.com/
|
|
9
|
+
"url": "git+https://github.com/ASCIIRenderer/ASCIIR.git"
|
|
10
10
|
},
|
|
11
|
-
"homepage": "https://
|
|
11
|
+
"homepage": "https://asciir.vercel.app",
|
|
12
12
|
"bugs": {
|
|
13
|
-
"url": "https://github.com/
|
|
13
|
+
"url": "https://github.com/ASCIIRenderer/ASCIIR/issues"
|
|
14
14
|
},
|
|
15
15
|
"publishConfig": {
|
|
16
16
|
"access": "public",
|