diff --git a/README.md b/README.md index d98d913..89b7e0c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,17 @@ # Devlog +![Devlog](./devlog.png) + Devlog is a powerful tool that automatically generates (b)log posts from your Git commit history, providing a natural language summary of your development progress. +It uses [ollama](https://github.com/ollama/ollama) to generate the blog posts locally so it never sends your data to third-party servers. + +## Requirements + +- [ollama](https://github.com/ollama/ollama) capable of running llama3 +- [git](https://git-scm.com/) +- [python](https://www.python.org/) + ## Description Devlog retrieves all the commit messages in a repository (local or remote), groups them by customizable time periods, and generates blog posts in natural language. This tool is perfect for developers who want to maintain a development log or changelog without the manual effort of writing blog posts. diff --git a/devlog.png b/devlog.png new file mode 100644 index 0000000..8e061a1 Binary files /dev/null and b/devlog.png differ