# "readme" extension?

**URL:** <https://www.ruby-forum.com/t/readme-extension/200013>\
**Category:** Radiant CMS\
**Created:** [December 2, 2010, 9:54pm UTC](https://www.ruby-forum.com/t/readme-extension/200013 "2010-12-02T21:54:04Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![Dobai-Pataky\_BSSSSl](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/d/77aa72/32.png) [@Dobai-Pataky\_BSSSSl](https://www.ruby-forum.com/u/Dobai-Pataky_BSSSSl)\
**Post date:** [December 2, 2010, 9:54pm UTC](https://www.ruby-forum.com/t/readme-extension/200013/1 "2010-12-02T21:54:04Z")

</div>

Hey everyone -

Does anyone know if something similar to a “readme” extension exists out  
there in the wild? I’m thinking something along the lines of  
site-specific  
documentation available through a top-level tab.

Would be a great little tool to help some clients along in how to use  
Radiant, links, instructions, embedded screencasts, etc.

If it doesn’t exist, then I guess I’ll give it a go.

Thanks!

- Joel

---

<div class="post-metadata">

**Author:** ![Joel\_O](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/j/f04885/32.png) [@Joel\_O](https://www.ruby-forum.com/u/Joel_O)\
**Post date:** [December 2, 2010, 10:09pm UTC](https://www.ruby-forum.com/t/readme-extension/200013/2 "2010-12-02T22:09:08Z")

</div>

[http://ext.radiantcms.org/extensions/5-help](http://ext.radiantcms.org/extensions/5-help)

Needs some updates still and I’ve wanted to add the ability to read  
from a site-specific HELP file

Patches are welcome, of course donations kick me into gear too 🙂  
[http://pledgie.com/campaigns/3373](http://pledgie.com/campaigns/3373)

---

<div class="post-metadata">

**Author:** ![Joel\_O](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/j/f04885/32.png) [@Joel\_O](https://www.ruby-forum.com/u/Joel_O)\
**Post date:** [December 2, 2010, 10:21pm UTC](https://www.ruby-forum.com/t/readme-extension/200013/3 "2010-12-02T22:21:04Z")

</div>

So awesome. Thanks for the heads up, Jim!

If there are any particular updates you would like to see integrated put  
them together in the issues list at github and I’ll see what I can do to  
contribute.

- Joel
