# Monochromium
> FOR STARDANCE REVIEWERS: IF THE COMMAND IS NOT FOUND AFTER YOU INSTALL IT, MAKE SURE YOU RELOAD YOUR SHELL
> A fast, local first CLI note-taking app
Monochromium lets you capture ideas, tasks, and mental health check-ins all without leaving the terminal!
## Why Monochromium?
Most note-taking apps are clunky, require opening another app, and are not built for developers in the slightest.
Monochromium is crazy light, modern, and allows for blazing fast workflows fully in plain text!
## Features
- Blazing-Fast, Small Binary
- Multiple Note Types
- Search and Filtering
- Fully Local Notes with SQLite
- Human-Readable Terminal Output
- Shell reminder system
## Install
### From Source
> Requires Rust
```bash
git clone https://github.com/Papaya-Voldemort/Monochromium
cd Monochromium
cargo install --path .
```
### From Cargo (Recommended)
> Requires Rust
```bash
cargo install monochromium
```
### From Github Binary
Download the correct binary for your OS [here](https://github.com/Papaya-Voldemort/Monochromium/releases/tag/v0.4.2)
### Verify
```bash
mono --version
```
## Usage
```bash
mono add "Ship v1.0"
mono add -t checkin "feeling great"
mono list
```
### Reminders
To opt into reminders, run the following command
> Mono Init updates your zshrc
```bash
mono init
```
## The Future
I already love the state Monochromium is in, but not all of our [spec.md](spec.md) is implemented fully.
We also have so many others plans for the future!
I want to add at least the following:
- More useful commands and flags
- Colored Outputs
- More Tests and Validation
- Smaller Binary
- Fuzzy Search
- A few others
So yeah a little work to go for v1.0.0 but we are well on our way!
## Contributions
> We are a very small team (of 1) so your PRs may take several days to review :)
Contributions are completely welcome and accepted.
Feel free to submit a PR or a Issue for anything!
For larger changes please make and link and issue to keep things more trackable.
## License
MIT
