| Name | create-readme JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | |
| Summary | |
| upload_time | 2023-06-27 18:59:32 |
| maintainer | |
| docs_url | None |
| author | rizerphe |
| requires_python | >=3.11,<4.0 |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# create-readme
create-readme is a tool that allows users to quickly and easily create README files with ChatGPT. By asking users a set of questions, create-readme generates a README based on the answers, eliminating the need to manually open OpenAI's website and type the prompt.
## Key Features
- Simple command-based interface for generating README files
- Efficient and time-saving solution compared to manually typing prompts
- Effortless use - the tool asks you questions, you don't have to worry about describing everything in detail to it
## Installation
To install create-readme, run the following command:
```shell
pipx install create-readme
```
## Usage
To use create-readme, follow these steps:
1. Open your terminal.
2. Run the command:
```shell
create-readme my-awesome-project
```
3. Answer the prompted questions to provide the necessary information for the README file generation.
4. Once you have answered all the questions, create-readme will generate a README file based on your inputs.
## Example
An example of a generated README is the file you're reading right now - it was manually cleaned up, but most of it is generated.
Raw data
{
"_id": null,
"home_page": "",
"name": "create-readme",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "rizerphe",
"author_email": "44440399+rizerphe@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/f8/2b/0c9c10dc09946e223e71b3127037057408b818fe1300d4e396f2f0891bf1/create_readme-0.1.1.tar.gz",
"platform": null,
"description": "# create-readme\n\ncreate-readme is a tool that allows users to quickly and easily create README files with ChatGPT. By asking users a set of questions, create-readme generates a README based on the answers, eliminating the need to manually open OpenAI's website and type the prompt.\n\n## Key Features\n\n- Simple command-based interface for generating README files\n- Efficient and time-saving solution compared to manually typing prompts\n- Effortless use - the tool asks you questions, you don't have to worry about describing everything in detail to it\n\n## Installation\n\nTo install create-readme, run the following command:\n\n```shell\npipx install create-readme\n```\n\n## Usage\n\nTo use create-readme, follow these steps:\n\n1. Open your terminal.\n2. Run the command:\n\n```shell\ncreate-readme my-awesome-project\n```\n\n3. Answer the prompted questions to provide the necessary information for the README file generation.\n4. Once you have answered all the questions, create-readme will generate a README file based on your inputs.\n\n## Example\n\nAn example of a generated README is the file you're reading right now - it was manually cleaned up, but most of it is generated.\n",
"bugtrack_url": null,
"license": "",
"summary": "",
"version": "0.1.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "47672713f4ddc5a508342600ff01bdfa232551e6031b186de6cb7ed09d80f930",
"md5": "fd4d25eea5c01756fc0deab39e4d670a",
"sha256": "7eb39c98201cc3cdabf4a13a0c3645dd7a5554d7a2a2a69820a29096b31c06ad"
},
"downloads": -1,
"filename": "create_readme-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fd4d25eea5c01756fc0deab39e4d670a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 5769,
"upload_time": "2023-06-27T18:59:29",
"upload_time_iso_8601": "2023-06-27T18:59:29.600878Z",
"url": "https://files.pythonhosted.org/packages/47/67/2713f4ddc5a508342600ff01bdfa232551e6031b186de6cb7ed09d80f930/create_readme-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f82b0c9c10dc09946e223e71b3127037057408b818fe1300d4e396f2f0891bf1",
"md5": "17209569f970bb2a306e5023109371c6",
"sha256": "3b75ddfc1242f8534774725dcf98a0f3817d59e10ec7adacf9bb1130b704ad1a"
},
"downloads": -1,
"filename": "create_readme-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "17209569f970bb2a306e5023109371c6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 4203,
"upload_time": "2023-06-27T18:59:32",
"upload_time_iso_8601": "2023-06-27T18:59:32.575666Z",
"url": "https://files.pythonhosted.org/packages/f8/2b/0c9c10dc09946e223e71b3127037057408b818fe1300d4e396f2f0891bf1/create_readme-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-27 18:59:32",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "create-readme"
}
