diff --git a/.github/assets/logo.webp b/.github/assets/logo.webp new file mode 100644 index 0000000..0b18914 Binary files /dev/null and b/.github/assets/logo.webp differ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..244229e --- /dev/null +++ b/LICENSE @@ -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. diff --git a/README.md b/README.md index 7d6fd38..3c764da 100644 --- a/README.md +++ b/README.md @@ -1 +1,51 @@ -# Docx to HTML +

+ + + + @scuderia-fe/docx-to-html +

+ +> WARNING: WIP package. Do not use + +
+ +

+ Blazing fast docx to html converter 🚀 +

+ +

+ + GitHub contributors + + + GitHub License + + NPM Version +
+

+ +## 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