0.0.6

[v0.0.6] - 2023-08-29

🐛 Bug Fixes

• Corrected PyPI issue where the readmeai package was not being installed correctly.
  • The conf directory was not being included in the PyPI distribution as it was located in the project's root directory.
  • The tool now uses the pkg_resources module to access the conf directory from the readmeai package.

---

0.0.5

[v0.0.5] - 2023-07-31

✨ Added

• Add .dockerignore file to exclude unnecessary files from the Docker image.

🛠️ Fixed

• Missing html closing tags in README tables were causing the GitHub pages site to render incorrectly.
  • Added closing tags to fix the issue.
  • Additionally, restructured a few sections of the README.

🛡️ Security

• Refactor Dockerfile to adhere to best practices.
  • Package Installation and Cleanup: Clean up cache after installing packages with apt-get to reduce the image size.
  • Non-root User Creation: Introduce a non-root user within the container to limit permissions and enhance security.
    • Assign a specific user ID and group ID that don't have superuser privileges.
  • File Permissions Management: Explicitly manage file permissions to prevent potential security risks when the image operates in varied contexts.

---

0.0.4

[v0.0.4] - 2023-07-30

Added

• 📦 Publish readme-ai CLI to PyPI under the module name readmeai.
  • Refactored the codebase to use Click, migrating from argparse.
  • Update directory name from src to readmeai to match PyPI module name.
  • Update readmeai modules to use relative imports.
  • Update metadata and dependency details in the pyproject.toml file.
• 📖 Update README.md documentation.
  • Add PyPI package badges at the top of the README.
  • Include instructions for downloading and running the readme-ai CLI from PyPI.
• ⚙️ Add helper script update_image.sh to push the latest image to Docker Hub.

Fixed

• 🐳 Update Dockerfile commands
  • Add line to install the tree command in order to generate the repository tree structure in the README.
  • Update installtion to use the latest readmeai distribution from PyPI.

Removed

• 🗑 Removed setup.py script from the project root directory.
  • Poetry is used for package management via pyproject.toml. Thus, setup.py is no longer needed.

---

0.0.3

[v0.0.3] - 2023-06-29

Added

• 🪄 Add pydantic to validate the user's repository and api key inputs.
  • Validation was moved from main.py to conf.py.
• 📖 Update README.md file contents.
  • Add Changelog section
  • Reformat HTML code blocks

Removed

• 📦 Remove dacite dependency now that pydantic is used for dataclass creation.

---

0.0.2

[v0.0.2] - 2023-06-28

Added

• 📃 Add CHANGELOG.md to track changes to the project.
• 📼 Add new directory examples/video to store mp4 videos to demonstrate the readme-ai tool.

Changed

• 🖋 Update Makefile and setup.sh to use poetry for dependency management.

Removed

• 🔧 Remove requirements.txt from the installation and setup scripts.
• 📄 Remove outdated example README.md files from the examples directory.

---

readme-ai v0.0.1

🏷 First Release: readme-ai v0.0.1

After a few months of development, the first release of readme-ai is here! This command-line tool leverages the power of OpenAI's GPT language model APIs to automatically generate beautifully structured and informative README markdown documents.

With readme-ai, you can effortlessly create detailed and easy-to-understand READMEs, saving valuable time that can be devoted to your project's development.

🔮 Features

Discover the unique features of readme-ai here.

🕹 How to Use

Get started quickly with our comprehensive guide here.

📍 Future Roadmap

We have an exciting vision for the future of readme-ai and are committed to continuous improvement based on your valuable feedback. We encourage users to contribute and participate in the ongoing development of the project. In the meantime, we hope that readme-ai becomes an everyday tool in your technical workflow!

If you're enjoying readme-ai, show your support by giving the project a star ⭐ and sharing it with your peers!