{"id":26933266,"url":"https://github.com/sharadbhat/readableurl","last_synced_at":"2025-04-02T09:18:17.950Z","repository":{"id":55555945,"uuid":"139070837","full_name":"sharadbhat/ReadableURL","owner":"sharadbhat","description":"An NPM package to generate random readable phrases.","archived":false,"fork":false,"pushed_at":"2020-10-03T10:46:17.000Z","size":4791,"stargazers_count":20,"open_issues_count":0,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-18T13:28:04.401Z","etag":null,"topics":["nodejs","npm-package","random-generation","readable-urls"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sharadbhat.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-06-28T21:40:12.000Z","updated_at":"2023-09-06T00:42:12.000Z","dependencies_parsed_at":"2022-08-15T03:10:28.557Z","dependency_job_id":null,"html_url":"https://github.com/sharadbhat/ReadableURL","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sharadbhat%2FReadableURL","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sharadbhat%2FReadableURL/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sharadbhat%2FReadableURL/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sharadbhat%2FReadableURL/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sharadbhat","download_url":"https://codeload.github.com/sharadbhat/ReadableURL/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246785474,"owners_count":20833498,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nodejs","npm-package","random-generation","readable-urls"],"created_at":"2025-04-02T09:18:17.442Z","updated_at":"2025-04-02T09:18:17.940Z","avatar_url":"https://github.com/sharadbhat.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# readable-url\n\nAn NPM package to generate readable random phrases to add to dynamically generated URLs.\n\n[GitHub repository](https://github.com/sharadbhat/ReadableURL)\n\nTo generate readable URLs like Twitch's clips.\n\nExample: https://clips.twitch.tv/WiseAcceptableSnoodPupper\n\n## Get started\n\nTo install,\n\n```sh\nnpm install readable-url\n```\n\n## Usage Instructions\n\nTo use the package, first require it.\n\n```js\nconst readable = require(\"readable-url\");\n```\n\nThen, we create an object.\n\n```js\n// Takes 3 parameters.\n// 1. A boolean value - If true, returns string in CamelCase, else lowercase.\n// 2. An integer value - The number of words to be generated in the string. (Between 2 and 10).\n// 3. A string - The seperator between the words.\n\nvar generator = new readable(); // true, 3 and '' are the default values.\n\n// var generator = new readable(false, 5, '-'); // Other options.\n```\n\nTo generate a random phrase,\n\n```js\nvar url = generator.generate();\n\nconsole.log(url); // Prints out 'ForgetfulHarshEgg'\n```\n\nThis can be used to add to the end of a URL.\n\nExample: https://example.com/photos/ForgetfulHarshEgg\n\nFor best results, use an integer value of 3, 4, or 5.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsharadbhat%2Freadableurl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsharadbhat%2Freadableurl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsharadbhat%2Freadableurl/lists"}