WPBP / WordPress-Plugin-Boilerplate-Powered

Wordpress Plugin Boilerplate but Powered with examples and a generator!
https://wpbp.github.io/
GNU General Public License v3.0
791 stars 114 forks source link

New README.md #235

Closed Ryvix closed 1 year ago

Ryvix commented 1 year ago

Hopefully I did this right.

This is an update to the README.md file.

I added some steps on using the Generator but now I'm not sure if that should even go in here or in the Generator README.md. It seemed useful to know how to use WPBP properly though so I left it there.

I added descriptions and links to all the things in the wpbp.json file.

It's still missing some info under the Snippets section. For example it probably could use a description under the Snippets heading about what snippets actually are and where to find them. It also has some missing descriptions for some and there are no links to them since I don't know where or even what exactly they are. Maybe that will come when I get more experience using it all.

I sort of merged what I had before into the existing README.md so of course feel free to edit it however you like it. I'm not sure what parts you want to add/remove/replace, etc.

Mte90 commented 1 year ago

So I like the new version, is very better as explanation.

My doubts are just for the library list. I chose the table version to get a readme that is more shorter but in that way it is difficult to get the description. A solution could be use the table just to have 2 columns with a single row with all the descriptions. For snippets they are in the boilerplate but points the position to the file can be a problem as it will means update the readme at every release to check if the line is changed. Reading your readme version I think that is complete as explanation.

About CMB2 as columns yes but in some cases you just want that library and not the whole CMB2.

Mte90 commented 1 year ago

I think that now is perfect, what do you think @erikyo @Ryvix?

In case if you want to help further the project a review on https://wpbp.github.io/ can be interesting with a ticket on https://github.com/wpbp/wpbp.github.io

erikyo commented 1 year ago

LGTM! 🚀

Ryvix commented 1 year ago

If you like it then I'm happy too. Nice work 😀