Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README.md does not show how to load the HTMLtoDOCX function #235

Open
Pomax opened this issue Feb 6, 2024 · 2 comments
Open

README.md does not show how to load the HTMLtoDOCX function #235

Pomax opened this issue Feb 6, 2024 · 2 comments

Comments

@Pomax
Copy link

Pomax commented Feb 6, 2024

The README.md currently contains:

Installation

Use the npm to install foobar.

npm install html-to-docx

Usage

await HTMLtoDOCX(htmlString, headerHTMLString, documentOptions, footerHTMLString)

But this has two problems. First, the package isn't called foobar ("Use npm to install html-to-docx"), but more importantly, it's missing the code that shows how to get HTMLtoDOCX: is it import { HTMLtoDOCX } from "html-to-docx"? Is it import HTMLtoDOCX from "html-to-docx"? Is it something else?

It would be good to update the README.md to address this omission.

@iamkhaya
Copy link

iamkhaya commented Apr 3, 2024

Hi @Pomax

You can see how to use the library in React in the example.

https://github.com/privateOmega/html-to-docx/blob/master/example/react-example/src/App.js#L5

@Pomax
Copy link
Author

Pomax commented Apr 4, 2024

I know, this issue is to get that information surfaced in the README.md instead, because that's where people expect to find it =)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants