DEV Community πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’»

KP
KP

Posted on

Designing an API to mash up public and private data

I have a Laravel application with logged-in users, posts, comments and likes (reactions).

I am designing an API to return all the data for a post (similar to this page here ). As you can see, the currently logged-in user can like / react to the main post, or any…

Top comments (0)

Timeless DEV post...

How to write a kickass README

Arguably the single most important piece of documentation for any open source project is the README. A good README not only informs people what the project does and who it is for but also how they use and contribute to it.

If you write a README without sufficient explanation of what your project does or how people can use it then it pretty much defeats the purpose of being open source as other developers are less likely to engage with or contribute towards it.