Skip to content

Commit

Permalink
add license and bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
itishermann committed Jun 26, 2024
1 parent f807de1 commit 8650db0
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 7 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) Hermann Kao

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,23 +22,24 @@ The Ollama Commit Summarizer Plugin enhances your development workflow by automa
- **Improved Collaboration:** Facilitate better collaboration and understanding among team members with clear and descriptive commit messages.
- **Enhanced Workflow:** Smooth integration with your existing development tools and workflows.

## Requirements

- Compatible with IntelliJ IDEA, PyCharm, WebStorm, PhpStorm, RubyMine, and other JetBrains IDEs.
- Requires a valid Git installation and configured repository.
- Ollama must be installed and running locally or remotely. Visit [Ollama][ollama-github-url] to learn more.

## Installation

1. Navigate to the JetBrains Marketplace.
2. Search for "Ollama Commit Summarizer."
3. Click "Install" and follow the prompts to add the plugin to your IDE.
4. Configure the plugin settings to match your preferences and start generating commit messages instantly.

## Requirements

- Compatible with IntelliJ IDEA, PyCharm, WebStorm, PhpStorm, RubyMine, and other JetBrains IDEs.
- Requires a valid Git installation and configured repository.

## Contributing

Contributions are welcome! If you'd like to contribute to this project, please follow these steps:

1. Fork the repository from [GitHub](https://github.com/itishermann/ollama-commit-summarizer).
1. Fork the repository from [GitHub][repo-url].
2. Create a new branch (`git checkout -b feature-branch`).
3. Make your changes and commit them (`git commit -am 'Add new feature'`).
4. Push to the branch (`git push origin feature-branch`).
Expand All @@ -57,3 +58,5 @@ Plugin based on the [IntelliJ Platform Plugin Template][template].

[template]: https://github.com/JetBrains/intellij-platform-plugin-template
[docs:plugin-description]: https://plugins.jetbrains.com/docs/intellij/plugin-user-experience.html#plugin-description-and-presentation
[repo-url]: https://github.com/itishermann/ollama-commit-summarizer
[ollama-github-url]:https://github.com/ollama/ollama
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pluginGroup = me.itishermann.ollamacommitsummarizer
pluginName = ollama-commit-summarizer
pluginRepositoryUrl = https://github.com/itishermann/ollama-commit-summarizer
# SemVer format -> https://semver.org
pluginVersion = 0.0.3
pluginVersion = 0.0.4

# Supported build number ranges and IntelliJ Platform versions -> https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
pluginSinceBuild = 232
Expand Down

0 comments on commit 8650db0

Please sign in to comment.