Skip to content

Commit

Permalink
feat: add readme and license
Browse files Browse the repository at this point in the history
  • Loading branch information
kettei-sproutty committed Jan 16, 2024
1 parent 6fcdda1 commit 99f5a85
Show file tree
Hide file tree
Showing 3 changed files with 72 additions and 1 deletion.
Binary file added .github/assets/logo.webp
Binary file not shown.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
52 changes: 51 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,51 @@
# Docx to HTML
<h3 align="center">
<a href="https://scuderia-fe.github.io/docx-to-html">
<img src="./.github/assets/logo.webp">
</a>
@scuderia-fe/docx-to-html
</h3>

> WARNING: WIP package. Do not use
<hr />

<p align="center">
<i align="center">Blazing fast docx to html converter 🚀</i>
</p>

<h4 align="center">
<a href="https://github.com/scuderia-fe/docx-to-html/graphs/contributors">
<img alt="GitHub contributors" src="https://img.shields.io/github/contributors-anon/scuderia-fe/docx-to-html">
</a>
<a href="https://opensource.org/licenses/Apache-2.0">
<img alt="GitHub License" src="https://img.shields.io/github/license/scuderia-fe/docx-to-html">
</a>
<img alt="NPM Version" src="https://img.shields.io/npm/v/%40scuderia-fe%2Fdocx-to-html">
<br>
</h4>

## Node

### Installation

```bash
npm install @scuderia-fe/docx-to-html
yarn add @scuderia-fe/docx-to-html
pnpm add @scuderia-fe/docx-to-html
bun add @scuderia-fe/docx-to-html
```

### Usage

```ts
import { convert } from "@scuderia-fe/docx-to-html";

const buffer = await file
.arrayBuffer()
.then((buffer) => new Uint8Array(buffer));
const html = wasm.convert(buffer);
```

### Rust

> WIP

0 comments on commit 99f5a85

Please sign in to comment.