[![Project license](https://img.shields.io/github/license/ExtremelyRyan/atomic.svg?style=flat-square)](LICENSE)
[![code with love by ExtremelyRyan](https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%99%A5%20by-ExtremelyRyan-ff1414.svg?style=flat-square)](https://github.com/ExtremelyRyan)
this project is still in rapid development, and is prone to breaking changes on main.
## What's Atomic?
Atomic is a command-line tool designed to streamline the process of making "atomic" commits. It addresses the challenge of remembering to save frequent snapshots of your code without disrupting your workflow. By defining custom commands in an atomic.toml file located in your project's root directory, Atomic allows you to execute your desired actions while automatically creating local commit snapshots in Git. This ensures that your changes are captured efficiently and without interrupting your focus.
### Built With
Rust, because I like it.Also with
[clap](https://lib.rs/crates/clap),
[git2](https://lib.rs/cratesgit2),
[thiserror](https://lib.rs/crates/thiserror),
[toml](https://lib.rs/crates/toml)
## Getting Started
### Prerequisites
Rust MSRV: 1.74
Windows 10/11
not tested on linux (yet)
### Installation
> **[?]**
> TODO
## Usage
> **[?]**
> TODO
## Roadmap
See the [open issues](https://github.com/ExtremelyRyan/atomic/issues) for a list of proposed features (and known issues).
- [Top Feature Requests](https://github.com/ExtremelyRyan/atomic/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc) (Add your votes using the ๐ reaction)
- [Top Bugs](https://github.com/ExtremelyRyan/atomic/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc) (Add your votes using the ๐ reaction)
- [Newest Bugs](https://github.com/ExtremelyRyan/atomic/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
## Support
Reach out to the maintainer at one of the following places:
- [GitHub issues](https://github.com/ExtremelyRyan/atomic/issues/new?assignees=&labels=question&template=04_SUPPORT_QUESTION.md&title=support%3A+)
- Contact options listed on [this GitHub profile](https://github.com/GITHUB_USERNAME)
## Project assistance
If you want to say **thank you** or/and support active development of Atomic:
- Add a [GitHub Star](https://github.com/ExtremelyRyan/atomic) to the project.
- Tweet about the Atomic.
- Write interesting articles about the project on [Dev.to](https://dev.to/), [Medium](https://medium.com/) or your personal blog.
## Authors & contributors
The original setup of this repository is by [Ryan](https://github.com/ExtremelyRyan).