Skip to content

Commit

Permalink
chore: prepare for initial publishing
Browse files Browse the repository at this point in the history
  • Loading branch information
calteran committed Jan 16, 2024
1 parent 906c306 commit 017516b
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 1 deletion.
30 changes: 30 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased](https://github.com/calteran/oliframe/compare/v0.1.0...HEAD)

## [0.1.0](https://github.com/calteran/oliframe/releases/tag/v0.1.0) - 2024-01-16

### Added
- reexport `image` and `csscolorparser::Color`
- Add support for border color in add_border function
- Rename project to "oliframe" and update references
- Add crossterm dependency and implement overwrite validation
- save images after border is applied
- Add support for accepting multiple file formats
- Add clap dependency and parser module

### Other
- split workflow into 2 jobs; add cargo deny
- *(deps)* remove indicatif & atty from dependencies
- setup github actions & dependabot
- documentation cleanup
- enhanced documentation
- significant rework of project structure and organization
- add sample files for testing
- update .gitignore to include sample photos
- update readme
- Initial commit
10 changes: 9 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
[package]
name = "oliframe"
description = "Add a border to one or more images (quickly)"
description = "Add a simple border to one or more images"
repository = "https://github.com/calteran/oliframe"
version = "0.1.0"
edition = "2021"
license = "MIT"
readme = "README.md"
documentation = "https://docs.rs/oliframe"
homepage = "https://github.com/calteran/oliframe"
categories = ["command-line-utilities", "graphics"]
keywords = ["image", "border", "frame"]
exclude = ["samples/", ".github/"]
rust-version = "1.75.0"

[dependencies]
clap = { version = "4.4.11", features = ["derive"] }
Expand Down
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# oliframe

[![oliframe](https://github.com/calteran/oliframe/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/calteran/oliframe/actions/workflows/ci.yml)
[![crates.io](https://img.shields.io/crates/v/oliframe.svg)](https://crates.io/crates/oliframe)
[![docs.rs](https://docs.rs/oliframe/badge.svg)](https://docs.rs/oliframe)
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://calteran.mit-license.org/)

**oliframe** is a simple command line tool to add borders to images. It can process a single image or multiple directories at a time.

## Installation
Expand Down

0 comments on commit 017516b

Please sign in to comment.