Hacker News Board Hacker News, browsed like a classic message board
Live data from Hacker News

Show HN: ReadMe.io – Beautiful Documentation Made Easy

readme.io

Post reply on HN
Print view View original

41–50 of 82 posts

Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy

#42

Post by gkoberger »

Kiro wrote: post #38
arenaninja wrote: post #29

The code blocks are really something else in terms of looks. Is that a custom look, or is it some open source plugin?

What's so special about it? Where can I see an example?

Here's a screenshot if you don't want to sign up (although signing up is pretty painless and completely free :) )

http://cl.ly/image/020W0r1x3J1n

Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy

#43

Post by adamjcooper »

gkoberger wrote: post #6
ing33k wrote: post #5

Looks awesome. I am currently using Swagger to document a REST API. can I import from the popular Swagger format ( YML) to your platform ?

Swagger is on the short-term roadmap! In the slightly shorter future (AKA it's working now, although we disabled it for new signups due to overload), we support apidocjs.com

This 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 API Blueprint?

Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy

#45

Post by dkural »

jonahx wrote: post #24

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 paying for?

Talking from the perspective of a startup person - 60 dollars is less than an hour of dev pay. It seems to me incredibly cheap. I often worry that SaaS startups undercharge and starve themselves out of stability & growth.

We've spent a lot of time putting together our API docs and it's nowhere as nice as this. The service they're providing is valuable to me as a way of solving this problem. I've never met or even heard of anyone working at readme.io btw - saw this on HN for the first time today.

Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy

#46

Post by dkural »

curiously wrote: post #27
benbristow wrote: post #21

"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 guys have built a fucking awesome tool." I don't know, but having swearing on a professional website is probably not the best way to go. Looks like a nice startup though.

to be fair the people who get appalled by reading the f-word are probably not the target customer. who drops f-word all the time? programmers, entrepreneurs, designers, developers, managers. certainly not established 100 year old corporation, but most certainly the hip, fast moving, horny, 20~30 something olds who eat and breathe technology.

More like insecure, inarticulate brogrammers who are getting burnt out overworking but think it's cool. I don't find swearing to be a conducive way of creating an inclusive, thoughtful work environment. I had enough of this fucking bullshit in college. Time to grow the fuck up.

Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy

#47

Post by innguest »

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 product. :)

1. Saving Basic Auth credentials so the user doesn't have to paste it in each time they test an endpoint.

2. A way to automatically populate the request form fields by clicking on an example request.

Keep it up; all my colleagues think it's a beautiful and well done tool.

Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy

#48

Post by gkoberger »

innguest wrote: post #47

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 product. :) 1. Saving Basic Auth credentials so the user doesn't have to paste it in each time they test an endpoint. 2. A way to automatically populate the request form fields by clicking on an example request. Keep it up; all my colleagues…

1. Will be done ASAP! (the multiple alerts is a huge pain)

2. Same

Shoot me an email (support@readme.io) and I'll keep you updated on the progress of these two features. And in the meantime, I'd love to pick your brain on your use-case.

Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy

#50

Post by csuwldcat »

kelseyfrancis wrote: post #39
phlakaton wrote: post #31

Earlier quoted context omitted.

Hey, I'm one of those, I think! For me, dropping a few in a conversation is one thing. Seeing it chiseled onto a web page is quite another.

Agreed. Would you want to see that your doctor's written stuff like that in your chart (e.g., "Patient's got some really fucking bad gout!")? No? Then maybe it's unprofessional.

I'm pretty sure comparing the addition of 'fucking' as a crass emphasis on the seriousness of someone's medical condition, with saying it excitedly when happy about a product or service you're enjoying, is drawing a flagrantly false equivalence. But heck (fuck?), that's just a reasoned, logical, non-PC take on this - three things that are sadly absent from much of the population these days.
Post reply on HN