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

Docs improve readability #46

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Conversation

iwaduarte
Copy link

I have created this doc PR because I think your README.md is great but very hard to get to the point of setting the minimal usage example.

I have edited a little bit and became this:
image

I have moved the specifics of (getting tokens and M1 installation) to external files. In this way, the user with these specific use cases can go there directly. IMHO I have left the main information on how to set up and install it more easily accessible.

Let me know your thoughts. Cheers.👍

@iwaduarte
Copy link
Author

iwaduarte commented Sep 21, 2023

You can check the output of these here: https://github.com/iwaduarte/cross-post/tree/docs

@shahednasser

Copy link
Owner

@shahednasser shahednasser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for this contribution! I think I'm fine with moving the M1 stuff, but the configurations I'd rather keep in the same file. They're an essential piece of information when you're setting up the tool for the first time, so having devs navigate to another document isn't helpful.

@iwaduarte
Copy link
Author

Okay, great. I am not used to this amount of configuration before usage in repos. But I guess it is a preference style. I have reverted the change.

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