forked from Ashwinvalento/cartoon-avatar
-
Notifications
You must be signed in to change notification settings - Fork 0
/
params.json
6 lines (6 loc) · 4.44 KB
/
params.json
1
2
3
4
5
6
{
"name": "Cartoon-avatar",
"tagline": "A library to generate cartoon style avatar URLs in Node.js",
"body": "[](https://travis-ci.org/Ashwinvalento/cartoon-avatar)\r\n\r\nNode.js cartoon avatar library\r\n========================\r\nA library to generate cartoon style avatar URLs in Node.js\r\n\r\n\r\nInstallation\r\n-----------\r\n```sh\r\n$ npm install cartoon-avatar\r\n```\r\n\r\nUsage\r\n------\r\n\r\n```javascript\r\nvar toonavatar = require('cartoon-avatar');\r\n\r\ntoonavatar.generate_avatar();\r\ntoonavatar.generate_avatar(options);\r\n\r\n```\r\n\r\n `options`:\r\n * `Gender` can be `male` or `m` or `female` or `f` .\r\n * `id` can be any number within the Range limit specified below. \r\n \r\n ` id Range` for a given gender :\r\n\t* MALE : 1 - 129 \r\n\t* FEMALE : 1 - 114\r\n\r\n`Note : ` id's greater than the limit will start over from 1.\r\n\r\n### Examples\r\n\r\n```javascript\r\n\r\nvar toonavatar = require('cartoon-avatar');\r\n\r\nvar url = toonavatar.generate_avatar()\r\n//Generates Image URL with random gender avatar.\r\n//https://raw.githubusercontent.com/Ashwinvalento/cartoon-avatar/master/lib/images/female/10.png\r\n//https://raw.githubusercontent.com/Ashwinvalento/cartoon-avatar/master/lib/images/male/86.png\r\n```\r\n`Image Preview :`\r\n\r\n \r\n\r\n```\r\nvar url = toonavatar.generate_avatar({\"gender\":\"male\"})\r\n//Generates Image URL with random Male avatars\r\n//https://raw.githubusercontent.com/Ashwinvalento/cartoon-avatar/master/lib/images/male/45.png\r\n```\r\n`Image Preview :`\r\n\r\n \r\n\r\n```\r\nvar url = toonavatar.generate_avatar({\"gender\":\"female\"})\r\n//Generates Image URL with random Female avatars\r\n//https://raw.githubusercontent.com/Ashwinvalento/cartoon-avatar/master/lib/images/female/68.png\r\n```\r\n`Image Preview :`\r\n\r\n \r\n\r\n```\r\nvar url = toonavatar.generate_avatar({\"gender\":\"male\",\"id\":5})\r\n//Generates Image URL with Male avatar having id 5\r\n//https://raw.githubusercontent.com/Ashwinvalento/cartoon-avatar/master/lib/images/male/5.png\r\n```\r\n`Image Preview :`\r\n\r\n \r\n\r\n```\r\nvar url = toonavatar.generate_avatar({\"gender\":\"female\",\"id\":5})\r\n//Generates Image URL with Female avatar having id 5\r\n//https://raw.githubusercontent.com/Ashwinvalento/cartoon-avatar/master/lib/images/female/5.png\r\n```\r\n`Image Preview :`\r\n\r\n \r\n\r\n\r\n##Running test\r\n\r\n```sh\r\n$ npm test\r\n```\r\n\r\n## Avatar Image Credits\r\n [People vector designed by Skydesign - Freepik.com](http://www.freepik.com/free-photos-vectors/people).\r\n \r\n\r\nLicense:\r\n--------\r\n\r\n(The MIT License)\r\n\r\nPermission is hereby granted, free of charge, to any person obtaining\r\na copy of this software and associated documentation files (the\r\n'Software'), to deal in the Software without restriction, including\r\nwithout limitation the rights to use, copy, modify, merge, publish,\r\ndistribute, sublicense, and/or sell copies of the Software, and to\r\npermit persons to whom the Software is furnished to do so, subject to\r\nthe following conditions:\r\n\r\nThe above copyright notice and this permission notice shall be\r\nincluded in all copies or substantial portions of the Software.\r\n\r\nTHE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,\r\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\r\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\r\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\r\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\r\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\r\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r\n",
"note": "Don't delete this file! It's used internally to help with page regeneration."
}