Show HN: ReadMe Recipes
I launched ReadMe here a few years ago as a Show HN (and even got the domain by randomly happening across someone giving it away here: https://news.ycombinator.com/item?id=6397526), so I figured this was a good place to post our newest feature, ReadMe Recipes.
Here's the link: https://readme.com/recipes
Most API documentation focuses on Reference Guides, which have the information you need about an API... all the parameters, endpoints, headers, query params, etc. They're really important! However, for a first-time user (or even someone more experienced), it's like handing someone a dictionary and telling them to learn the language.
So, we built Recipes, which are interactive, use case-based code walkthroughs aimed at helping you get your users to solve specific problems. Recipes pair a common use case for your API or technical product with a snippet of code and then walk through the code explaining what everything does.
Rather than focus on GETs and PUTs and POSTs, Recipes makes it easy to help your users accomplish the actual tasks they're looking to do.
Many of you here already use ReadMe, so it's free with whatever plan you're on. And if you don't use ReadMe and your company has an API or other technical product, check us out :)
If you wanna chat, either comment here or my email is in my profile!
-Greg