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 and License #15

Open
rowanc1 opened this issue Oct 5, 2021 · 1 comment
Open

Readme and License #15

rowanc1 opened this issue Oct 5, 2021 · 1 comment

Comments

@rowanc1
Copy link

rowanc1 commented Oct 5, 2021

Congrats on your Very scary version bump! 😆

Any chance that you could add a license file (package.json says MIT) as well as a brief readme that explains the package?

Thanks!

I just released prosemirror-docx but this might be another way to create/export -- as well as all of the other nice things that pandoc does! Looking forward to learning more.

@idreyn
Copy link
Contributor

idreyn commented Oct 25, 2021

Thanks for your interest in this project! I've finally added a license, and I am working on a readme, which will take some time. Unlike prosemirror-docx (which looks very cool) this code is not very plug-and-play — it's more of a kit of parts for building a converter, and it's better circumvented entirely for a typical ProseMirror schema. I want to convey to visitors that it probably isn't what they're looking for, while also documenting its API. In the meantime, a lack of a readme seems to serve that first purpose nicely. :)

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