Skip to content

Commit 765b028

Browse files
committed
chore: update README for version 0.5.6 and add omniscript-converters installation instructions
1 parent 9b909f4 commit 765b028

File tree

1 file changed

+23
-10
lines changed

1 file changed

+23
-10
lines changed

README.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Like Excel & Google Sheets
6969
</tr>
7070
</table>
7171

72-
> **🎯 Current Version:** `v0.5.4` | **🔥 Status:** Active Development | **📅
72+
> **🎯 Current Version:** `v0.5.6` | **🔥 Status:** Active Development | **📅
7373
> Next Release:** v1.0.0
7474
7575
---
@@ -113,9 +113,14 @@ pnpm add -g omniscript-cli
113113
**Library Integration**
114114

115115
```bash
116+
# Core parser only
116117
npm install omniscript-parser
117-
# or
118-
pnpm add omniscript-parser
118+
119+
# With professional format converters
120+
npm install omniscript-parser omniscript-converters
121+
122+
# or with pnpm
123+
pnpm add omniscript-parser omniscript-converters
119124
```
120125

121126
</td>
@@ -131,6 +136,12 @@ osf parse examples/rich_demo.osf
131136
# Render to beautiful HTML
132137
osf render examples/rich_demo.osf --format html
133138

139+
# Export to professional formats (requires omniscript-converters)
140+
osf render examples/rich_demo.osf --format docx --output report.docx
141+
osf render examples/rich_demo.osf --format pptx --output slides.pptx
142+
osf render examples/rich_demo.osf --format xlsx --output data.xlsx
143+
osf render examples/rich_demo.osf --format pdf --output document.pdf
144+
134145
# Export to other formats
135146
osf export examples/rich_demo.osf --target md
136147

@@ -203,13 +214,15 @@ osf format examples/rich_demo.osf
203214

204215
[![omniscript-parser](https://img.shields.io/npm/v/omniscript-parser?label=omniscript-parser&logo=npm&color=CB3837)](https://www.npmjs.com/package/omniscript-parser)
205216
[![omniscript-cli](https://img.shields.io/npm/v/omniscript-cli?label=omniscript-cli&logo=npm&color=CB3837)](https://www.npmjs.com/package/omniscript-cli)
217+
[![omniscript-converters](https://img.shields.io/npm/v/omniscript-converters?label=omniscript-converters&logo=npm&color=CB3837)](https://www.npmjs.com/package/omniscript-converters)
206218

207219
</div>
208220

209-
| Package | Description | Version | Downloads |
210-
| ------------------------------------------------------------------------ | -------------------------------------------- | ------------------------------------------------------ | ------------------------------------------------------- |
211-
| **[omniscript-parser](https://www.npmjs.com/package/omniscript-parser)** | Core parsing library with TypeScript support | ![npm](https://img.shields.io/npm/v/omniscript-parser) | ![npm](https://img.shields.io/npm/dm/omniscript-parser) |
212-
| **[omniscript-cli](https://www.npmjs.com/package/omniscript-cli)** | Command-line tools with `osf` binary | ![npm](https://img.shields.io/npm/v/omniscript-cli) | ![npm](https://img.shields.io/npm/dm/omniscript-cli) |
221+
| Package | Description | Version | Downloads |
222+
| -------------------------------------------------------------------------------- | ------------------------------------------------------ | ---------------------------------------------------------- | ----------------------------------------------------------- |
223+
| **[omniscript-parser](https://www.npmjs.com/package/omniscript-parser)** | Core parsing library with TypeScript support | ![npm](https://img.shields.io/npm/v/omniscript-parser) | ![npm](https://img.shields.io/npm/dm/omniscript-parser) |
224+
| **[omniscript-cli](https://www.npmjs.com/package/omniscript-cli)** | Command-line tools with `osf` binary | ![npm](https://img.shields.io/npm/v/omniscript-cli) | ![npm](https://img.shields.io/npm/dm/omniscript-cli) |
225+
| **[omniscript-converters](https://www.npmjs.com/package/omniscript-converters)** | Professional format converters (DOCX, PPTX, XLSX, PDF) | ![npm](https://img.shields.io/npm/v/omniscript-converters) | ![npm](https://img.shields.io/npm/dm/omniscript-converters) |
213226

214227
---
215228

@@ -286,13 +299,13 @@ pnpm run dev
286299
<summary><b>📋 For Maintainers</b></summary>
287300

288301
```bash
289-
# Patch release (0.5.4 → 0.5.5)
302+
# Patch release (0.5.6 → 0.5.7)
290303
pnpm run release:patch
291304

292-
# Minor release (0.5.4 → 0.6.0)
305+
# Minor release (0.5.6 → 0.6.0)
293306
pnpm run release:minor
294307

295-
# Major release (0.5.4 → 1.0.0)
308+
# Major release (0.5.6 → 1.0.0)
296309
pnpm run release:major
297310
```
298311

0 commit comments

Comments
 (0)