shahednasser / cross-post

Cross Post a blog to multiple websites
https://www.npmjs.com/package/cross-post-blog
MIT License
122 stars 16 forks source link

Docs improve readability #46

Open iwaduarte opened 1 year ago

iwaduarte commented 1 year ago

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 commented 1 year ago

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

@shahednasser

iwaduarte commented 1 year ago

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.