create account

[Steemit Hunt] Readme - Developer documentation made easy by ntomaino

View this thread on: hive.blogpeakd.comecency.com
· @ntomaino · (edited)
$2.47
[Steemit Hunt] Readme - Developer documentation made easy
[Readme](https://dash.readme.io/) makes it easy for developers to create great documentation, provide transparency around code changes and build vibrant dev communities.

http://i.imgsafe.org/e36b86fca0.png

# Background

This product is relevant to Steemit right now. The most important aspect of a crypto token protocol is the developer community and if the Steem protocol is successful the success is going to be led by developers. Right now, the [Steem documentation](https://steem.io/documentation/) is not very good. Additionally, there is no transparent changelog that highlights code changes and no comprehensive developer hub (see @tuck-fheman's thoughts about the lack of transparency on protocol changes in the post and comments [here](https://steemit.com/philosophy/@tuck-fheman/our-corrupt-sense-of-fairness-or-steemit-s-incessant-rule-changes)).

# Why would you want to use it?
Any developer building an API or leading an open-source project would want to use Readme as a way to foster a developer community.

Any aspiring developer on a protocol would want the protocol to implement it so that they could get up to speed building products on the protocol faster. I'm personally interested in building curation bots but haven't been able to figure it out with existing documentation (I'm a very novice dev). The

# What are some new products that you love? Hunt them with the tag #steemit-hunt
___

http://i.imgsafe.org/7347989cc0.png

* Follow me on [Steemit](https://steemit.com/@ntomaino)
* Follow me on [Twitter](https://twitter.com/ntmoney)
* Hear about why I'm excited about Steemit [here](https://www.youtube.com/watch?v=nZknEN-xt6s)
___
👍  , , , , , , , , , , , , , , , , , ,
properties (23)
authorntomaino
permlinksteemit-hunt-readme-beautiful-developer-hubs-made-easy
categorysteemit
json_metadata{"tags":["steemit","steemit-hunt","steem","devs","crypto-news"],"links":["https://www.youtube.com/watch?v=nZknEN-xt6s"]}
created2016-08-25 00:29:24
last_update2016-08-25 14:21:12
depth0
children8
last_payout2016-09-25 04:43:12
cashout_time1969-12-31 23:59:59
total_payout_value1.890 HBD
curator_payout_value0.579 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length1,659
author_reputation19,085,142,785,364
root_title"[Steemit Hunt] Readme - Developer documentation made easy"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id975,351
net_rshares2,804,681,720,899
author_curate_reward""
vote details (19)
@balaji ·
Paging the Steem core devs @dantheman @smooth @berniesanders
properties (22)
authorbalaji
permlinkre-ntomaino-steemit-hunt-readme-beautiful-developer-hubs-made-easy-20160825t014329301z
categorysteemit
json_metadata{"tags":["steemit"],"users":["dantheman","smooth","berniesanders"]}
created2016-08-25 01:43:30
last_update2016-08-25 01:43:30
depth1
children0
last_payout2016-09-25 04:43:12
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length60
author_reputation1,062,482
root_title"[Steemit Hunt] Readme - Developer documentation made easy"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id976,194
net_rshares0
@bmann ·
$0.04
The devs on Github for steemit.com have been responsive &  excellent. I've made some pull requests to fix the README there, but that's really the only piece of documentation. The protocol / steemd API is way more complicated,  would be great to see readme  or similar implemented.  I'm not a very good Dev, but I can write docs & examples, and I bet there are more people like me that would contribute.
👍  
properties (23)
authorbmann
permlinkre-ntomaino-steemit-hunt-readme-beautiful-developer-hubs-made-easy-20160825t050656476z
categorysteemit
json_metadata{"tags":["steemit"]}
created2016-08-25 05:07:00
last_update2016-08-25 05:07:00
depth1
children1
last_payout2016-09-25 04:43:12
cashout_time1969-12-31 23:59:59
total_payout_value0.034 HBD
curator_payout_value0.002 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length402
author_reputation58,077,570,820
root_title"[Steemit Hunt] Readme - Developer documentation made easy"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id978,169
net_rshares72,878,271,304
author_curate_reward""
vote details (1)
@bmann ·
$0.04
And man you're kicking my butt on steemit-hun posts ;) I want to get back to some theme work on steempress so I can actually display this stuff nicely, hence no postings on the tag!
👍  
properties (23)
authorbmann
permlinkre-bmann-re-ntomaino-steemit-hunt-readme-beautiful-developer-hubs-made-easy-20160825t050859502z
categorysteemit
json_metadata{"tags":["steemit"]}
created2016-08-25 05:09:03
last_update2016-08-25 05:09:03
depth2
children0
last_payout2016-09-25 04:43:12
cashout_time1969-12-31 23:59:59
total_payout_value0.036 HBD
curator_payout_value0.001 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length181
author_reputation58,077,570,820
root_title"[Steemit Hunt] Readme - Developer documentation made easy"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id978,187
net_rshares72,878,271,304
author_curate_reward""
vote details (1)
@samupaha ·
$0.04
This should be combined with the upcoming wiki: https://steemit.com/steem/@ned/the-first-phase-of-the-steem-faq-and-wikee-consolidation-of-knowledge
👍  
properties (23)
authorsamupaha
permlinkre-ntomaino-steemit-hunt-readme-beautiful-developer-hubs-made-easy-20160825t053457310z
categorysteemit
json_metadata{"tags":["steemit"],"links":["https://steemit.com/steem/@ned/the-first-phase-of-the-steem-faq-and-wikee-consolidation-of-knowledge"]}
created2016-08-25 05:34:57
last_update2016-08-25 05:34:57
depth1
children4
last_payout2016-09-25 04:43:12
cashout_time1969-12-31 23:59:59
total_payout_value0.037 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length148
author_reputation43,637,433,899,367
root_title"[Steemit Hunt] Readme - Developer documentation made easy"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id978,403
net_rshares72,878,271,304
author_curate_reward""
vote details (1)
@ntomaino ·
Good call.  I hope this is prioritized by the Steem core devs as in my mind this will be the single biggest driver of growth (more transparency, more devs, more useful apps that use Steem).
properties (22)
authorntomaino
permlinkre-samupaha-re-ntomaino-steemit-hunt-readme-beautiful-developer-hubs-made-easy-20160825t054054300z
categorysteemit
json_metadata{"tags":["steemit"]}
created2016-08-25 05:40:54
last_update2016-08-25 05:40:54
depth2
children3
last_payout2016-09-25 04:43:12
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length189
author_reputation19,085,142,785,364
root_title"[Steemit Hunt] Readme - Developer documentation made easy"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id978,449
net_rshares0
@samupaha ·
If I have understood the situation right, Steemit doesn't have currently manpower to spare to write good docs. But they are interested in hiring somebody to do that, so if you know somebody who could be a good fit for that job, contact Ned.
properties (22)
authorsamupaha
permlinkre-ntomaino-re-samupaha-re-ntomaino-steemit-hunt-readme-beautiful-developer-hubs-made-easy-20160825t055857696z
categorysteemit
json_metadata{"tags":["steemit"]}
created2016-08-25 05:58:57
last_update2016-08-25 05:58:57
depth3
children2
last_payout2016-09-25 04:43:12
cashout_time1969-12-31 23:59:59
total_payout_value0.000 HBD
curator_payout_value0.000 HBD
pending_payout_value0.000 HBD
promoted0.000 HBD
body_length240
author_reputation43,637,433,899,367
root_title"[Steemit Hunt] Readme - Developer documentation made easy"
beneficiaries[]
max_accepted_payout1,000,000.000 HBD
percent_hbd10,000
post_id978,578
net_rshares0