Better README - Githubissues

MohammadYounes / rtlcss

Framework for transforming Cascading Style Sheets (CSS) from Left-To-Right (LTR) to Right-To-Left (RTL)

https://rtlcss.com

MIT License

1.68k stars 129 forks source link

Better README #27

Closed ai closed 9 years ago

ai commented 9 years ago

RTLCSS is awesome. I want to use as example of PostCSS power. But I can puut a link, because RTLCSS’s README doesn’t tell what plugin does (many of users doesn’t know what is RTL is).

Maybe you put a CSS input/output example and some before/after screenshot?

ai commented 9 years ago

BTW, what is a purpose of “CSS Syntax” section?

MohammadYounes commented 9 years ago

Thanks! I'm kinda bad at documentation ...

RTLCSS’s README doesn’t tell what plugin does

I thought it was obvious ( I updated the main description).

what is a purpose of “CSS Syntax” section?

The CSS Syntax helps clarify the names as RTLCSS allows you to change its behavior by implementing your own processing instructions or directives on rule, declaration and property level.

For example, I used it here to prefix all rules:

.dialog { ... }

becomes :

.ajs-dialog { ...}

Maybe you put a CSS input/output example and some before/after screenshot?

The documentation requires complete revision indeed! Also the lib itself (thinking RTLCSS 2) ... but I just can't find the time.

Have you seen the wiki ?

MohammadYounes commented 9 years ago

@ai plz check the updated README and let me know your thoughts!

ai commented 9 years ago

@MohammadYounes much better, but we have some problems:

CSS Syntax section should not be in most important top part of README. These top sections is for project overview and exmaples. Not for details.
Can you make a screenshop of some real site (maybe in mobile version with small width) before and after RTLCSS. Current border examples is confused, because it is easy to misss border changes.

MohammadYounes commented 9 years ago

@ai Thanks for the input, README updated.

ai commented 9 years ago

@MohammadYounes awesome!

Can I ask about one more fix (I think it will make README more cute) :).

Can you cut browser window around GitHub screenshot (it is too bright) and put screenshots side by side (you can use align=right and alight=left in <img)

ai commented 9 years ago

I put link to your plugin to PostCSS features examples :)

MohammadYounes commented 9 years ago

Thanks! I added a quick access menu and resized the images so they would fit side by side, let me know if the browser window still needs to be removed or not!

ai commented 9 years ago

Now README looks perfect :D

MohammadYounes commented 9 years ago

Thanks ;)