A Readme Generator that uses Generative AI to create it
| Command | Action |
|---|---|
Generate Readme |
Create a Readme based on the file tree structure of the current workspace (Needs configure the api key first) |
Show Api |
Shows the current api token configured |
Set Api Token |
Set a new Api Token to use |
Reset Api Token |
Delete any api token configured on VsCode |
Get Current Dir |
An util command that shows the current dir of the workspace |
The smart readme is an extension for VSCode that uses Generative Language to create a template to start your readme.
At first, it will collect an API key that you need to use. So, after configuring your API key, it will read the entire file tree in the workspace to create a JSON string that will be sent to Gemini AI Generative Language, which will return a markdown file with all the text based on the file tree of your workspace. After that, the extension will collect the text and save it to a new file, Readme.md, created in your workspace.
- Get the API Key on the Google AI Studio
After that, you must do:
- Set API Key on VSCode
Use the command Set Api Token
- Open a workspace or create one
- Generate a Readme
Use the command
Generate Readme
✅: Added❗: Needs to be added
| Feature | Status |
|---|---|
| Read archive content | ❗ |
| Allow the user select another versions of the generated readme | ❗ |
| Improve the prompt to generate best readmes | ❗ |
We appreciate your contributions! To contribute, follow these steps:
-
Fork the repository
-
Clone your fork
git clone https://github.com/your-username/your-repository.git cd your-repository -
Create a branch
git checkout -b feat/feature-name
-
Make your changes
-
Commit your changes
git add . git commit -m "Description of the changes"
-
Push your changes
git push origin feat/feature-name
-
Open a Pull Request