ReadMe Reviews

Social recommendations and mentions

• Documenting a Go API with OpenAPI 3 Standard: A Practical Guide

  Readme: Readme is a popular documentation platform that can be used for API documentation. It provides a user-friendly interface for creating and publishing API documentation, and supports both OpenAPI and Swagger. - Source: dev.to / about 1 month ago

• Docs Portal Design Tools??

  I'm looking for some cool tools to use for the design aspect. Similar to readme.com. - Source: Reddit / 2 months ago

• free-for.dev

  Readme.com — Beautiful documentation made easy, free for Open Source. - Source: dev.to / 4 months ago

• I'm a front-end dev currently being asked to work on a Rails API backend. What are some good resources to get comfortable with the language and the framework?

  Https://github.com/rswag/rswag - helps generate Swagger documentation (you can upload it to an external service, like readme.com or serve from your Rails app). - Source: Reddit / 5 months ago

• YNAB Down?

  YNAB must use readme.com as they had a major outage today that affected all businesses that use them with the DNS error 1016. We were also affected at my job. - Source: Reddit / 7 months ago

• Product doc versioning or alternatives

  u/IntroThrive why has readme.com been met with resistance? - Source: Reddit / 10 months ago

• Product doc versioning or alternatives

  Ha, publishing pipeline is basically drafting in Google Docs and then transferring to and publishing in WordPress. I've been pushing for an actual docs application (I've used https://readme.com/ in my previous role) but it's been met with resistance. - Source: Reddit / 10 months ago

• Everything you need to know about monorepos

  I don't know about AsyncAPI but with https://readme.com/ you can upload an OpenAPI file and it generates a nice documentation. - Source: Hacker News / about 1 year ago

• What are the must-have steps from a concept to launch?

  For a few out-of-the-box options, readme.com has a good one (with monthly fee), but I just swagger (i.e. https://api.streamduo.com/swagger-ui.html) which has some pretty easy integration depending on what you wrote your APIs in. I use springboot, and it's super easy to generate that API page. - Source: Reddit / about 1 year ago

• Swagger UI alternative for gRPC

  To get more ;) Swagger-like plan is free. For 90$ you get tool more like redoc.ly Basic or readme.com Startup plan. - Source: Reddit / over 1 year ago

• Ask HN: Best tool used for hosting API and technical documentation

  I have heard really good things about about https://readme.com/. - Source: Hacker News / over 1 year ago

• Free for dev - list of software (SaaS, PaaS, IaaS, etc.)

  Readme.com — Beautiful documentation made easy, free for Open Source. - Source: dev.to / over 1 year ago

• API documentation question

  I would recommend looking into Swagger. You specify your entire API (models, endpoints, requests, responses, and descriptions too) and there are additional tools that understand Swagger syntax. For instance, https://readme.com lets you upload a Swagger specification and generate documentation from it. There are also tools out there to generate boilerplate code for your application as well, such as models and HTTP... - Source: Reddit / almost 2 years ago

• Show HN: ReadMe Recipes

  Posting the link here so it's clickable: https://readme.com/recipes. - Source: Hacker News / almost 2 years ago

• Show HN: ReadMe Recipes

  Heya HN! 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...... - Source: Hacker News / almost 2 years ago

• I need suggestions for the API doc SAAS platform that I am building.

  I am trying to solve a couple of problems in the API doc SAAS domain. If any one of you ever had a chance to use any existing product like https://readme.com/ to document your APIs, what did you feel was missing and what would you like to see in the upcoming product? - Source: Reddit / about 2 years ago