ipsum.ir/README.md

33 lines
880 B
Markdown
Raw Normal View History

2014-09-08 08:07:47 +00:00
# IPSUM.IR
The code powering [ipsum.ir](http://ipsum.ir), a categorized ipsum generator with REST API for those who care.
## REST API
2014-09-08 08:09:06 +00:00
The grammer of our API is as follows:
2014-09-08 08:07:47 +00:00
http://ipsum.ir/:category/:unit/:amount
#### Categories
2014-09-09 11:09:40 +00:00
Available categories: news, design and normal
We're planning to add more categories soon, feel free to add a category!
2014-09-08 08:07:47 +00:00
#### Units
2014-09-08 08:09:06 +00:00
Currently, units are paragraph as `p`, word as `w` and character as `c`. Please note, character doesn't include spaces.
2014-09-08 08:07:47 +00:00
Examples:
http://ipsum.ir/design/p/2
http://ipsum.ir/normal/c/250
http://ipsum.ir/design/w/10
## Contributing
Our dictionaries are simply an array of words, if you have a bunch of words (+35) in a category, you can add it yourself or contact me [mahdi@dibaiee.ir](mailto:mahdi@dibaiee.ir) and I'll add them.
Any contribution is appreciated, new ideas, bug reports, etc.