ReadMe.io
Dev tools
documentation hosting
SHOW HN2014
266points
79comments
#57of 2,272 in 2014
Top 3%of 2014 by points
How HN took it
MixedNo clear lean
19 positive, 16 neutral or asking, 3 mixed, 8 critical, out of 46 comments about the project. Thread score +0.21.
Pricing: 4 for, 3 againstDesign: 5 for, 2 againstIdea: 3 for, 1 againstDocs: 1 for, 1 againstPerformance: 0 for, 1 against
The thread, comment by comment
Each row is a top-level comment and its replies, in HN's order. Select a cell to open that comment on HN.
positive neutral or mixed critical about another commenter or something else the maker
What HN said
What people liked
Beautiful, polished design and code block styling
From 4 comments
Love the attention to details, like the focus event on the password field: https://dash.readme.io/login
karanbhangui on HNHeap Analytics is in the process of moving over our documentation to ReadMe.io and so far the process has been amazing. The ReadMe team is really responsive and helpful, the…
codezero on HNThe code blocks are really something else in terms of looks. Is that a custom look, or is it some open source plugin?
arenaninja on HNThis looks awesome. I can't wait to start using it!
samplusplus on HN
Easy for non-technical staff to maintain docs
From 2 comments
We've been using Readme.io for our documentation for a while now (http://api.knowtify.io). Love the team, but mostly I love that the non-technical folks (ie - me) can…
dskaletsky on HNI use ReadMe, and I haven't used flatdoc, so correct me if I make an assumption about what it does. A huge benefit of ReadMe is the document organization and drafting…
codezero on HN
Responsive team and good migration help
From 2 comments
Heap Analytics is in the process of moving over our documentation to ReadMe.io and so far the process has been amazing. The ReadMe team is really responsive and helpful, the…
codezero on HNWe (StatusPage.io) are also in the process of getting our docs switched over. Greg helped out with the initial migration which was awesome. Definitely recommend other SaaS…
dannyolinsky on HN
Objections
Price seems high compared to free alternatives
From 2 comments
This looks nice but $60/mo seems incredibly pricey when there are also nice, and similar, open source solutions such as http://ricostacruz.com/flatdoc/ What extra value am I…
jonahx on HNLove it and agree it's beautiful, but as a startup, I disagree with the "it's just 1hr dev a month" in cost. Setting up something from GitHub onto Heroku or similar costs me…
hughstephens on HN
Unclear what the product does
From 1 comment
Just tried to learn about your product... I was, and still am, completely confused about what it does and why I need it...
SkylerTodd on HN
Profanity on the public site looks unprofessional
From 2 comments
"ReadMe has made our lives infinitely easier. We've had it on our todo list for over a year, and a day after finding ReadMe we had our docs launched. We're super impressed. You…
benbristow on HNPersonally I find the "hip" use of curse words a red flag for working with a company. If you can't even be professional on your external-facing site, it's a certainty that I'll…
claar on HN
Requires JavaScript to read docs
From 1 comment
This seems highly dependent on Javascript for displaying its (actually static) content. As someone who likes his notebook fan to stay calm and not have websites shove obnoxious…
aw3c2 on HN
Requests
Swagger import
From 2 comments
Looks awesome. I am currently using Swagger to document a REST API. can I import from the popular Swagger format ( YML) to your platform ?
ing33k on HNCurrently, you can do it manually or using http://apidocjs.com. (The latter is disabled for new accounts due to heavy load; will be back this week.) Swagger (and a few other even…
gkoberger on HN
Auto-generated client libraries
From 1 comment
I've seen a couple of these projects lately. They are really cool and I see the need. What seems to be missing (and is a no-brainer in my opinion) are auto-generated client…
callmeed on HN
Free plan for open source projects
From 1 comment
Looks great. Wish there was a plan for opensource projects, which allowed me to use customized landing page etc.
gnufied on HN
Saved Basic Auth credentials in API tester
From 1 comment
This looks beautiful and I have been testing your product yesterday and today. I have the following suggestions, which if implemented would convert the company I work for to your…
innguest on HN
Questions
How does search work
From 1 comment
The most important feature for documentation is /a really good/ search. I can't see anything about searching on the site? Can you clarify? IMO everybody should use…
susi22 on HN
Can docs be exported
From 1 comment
Will I be able to export my docs? I'm not really willing to put my docs on readme.io without knowing I can export all my work if you all go under. I'm currently an Apiary for…
uncoder0 on HN
Can existing docs be imported
From 2 comments
I am currently working on improving the documentation for Conda, Bokeh, Numba, and a bunch of other scipy-related tools. This looks pretty spiffy. How hard is it to import…
afarrell on HNThis looks very nice. Since you mentioned Swagger--We've started using API Blueprint for internal API design and collaboration. Do you have any plans to support importing from…
adamjcooper on HN
Alternatives named
readthedocs.org
From 2 comments
The most important feature for documentation is /a really good/ search. I can't see anything about searching on the site? Can you clarify? IMO everybody should use…
susi22 on HNAs far as I see, Readme.io has additional features but everything you've listed is available for free on readthedocs.org, built on Sphinx which is free software.
phaer on HN
Apiary
From 1 comment
We just released our API on apiary (http://docs.commando.apiary.io), but after finding ReadMe.io on ProductHunt, we signed up for a paid plan that very day, and are in the…
nodesocket on HN
Slate
From 1 comment
Looks like Slate - https://github.com/tripit/slate
eclipxe on HN
flatdoc
From 1 comment
This looks nice but $60/mo seems incredibly pricey when there are also nice, and similar, open source solutions such as http://ricostacruz.com/flatdoc/ What extra value am I…
jonahx on HN