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

extending readme #4

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

extending readme #4

wants to merge 1 commit into from

Conversation

goudete
Copy link

@goudete goudete commented Oct 5, 2023

Hey @TGlide, really cool project!

I thought you might like a more detailed ReadMe - let me know if it's useful!

Created it with https://www.hello-cluster.com/

@vercel
Copy link

vercel bot commented Oct 5, 2023

Someone is attempting to deploy a commit to a Personal Account owned by @TGlide on Vercel.

@TGlide first needs to authorize it.

@rotimi-best
Copy link
Contributor

Thanks for this @goudete, I was thinking of adding this as well.

I will suggest most importantly adding the expected props the Editor component can accept similar to what novel.sh has: https://github.com/steven-tey/novel

image

I will also add that the installation guide isn't that important as everyone should know how to clone and install however since this is a library there will be a rare case that anyone is coming to the README to see how to setup the repo locally, except contributors. Instead I think people would want to see what they can do with the library (this was the first thing I looked for when I was looking for a svelte based notion editor.)

In that case I will suggest we follow the same approach as that of the original novel repo 👍

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

Successfully merging this pull request may close these issues.

2 participants