Merge pull request #1 from askolesov/add-readme

Add readme

.github/workflows/lint.yaml

@@ -0,0 +1,23 @@
+name: Lint
+
+on:
+  push:
+  workflow_call:
+
+jobs:
+  lint:
+    name: Run golanci-lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-go@v5
+        with:
+          go-version-file: "go.mod"
+
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v5
+        with:
+          version: v1.61.0
+          args: --timeout=5m

.github/workflows/test.yml

@@ -9,14 +9,18 @@ on:
 jobs:
 
   build:
+    name: Build and test
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
 
     - name: Set up Go
       uses: actions/setup-go@v4
       with:
-        go-version: '1.21'
+        go-version-file: "go.mod"
+
+    - name: Install exiftool
+      run: sudo apt-get update && sudo apt-get install -y exiftool
 
     - name: Build
       run: go build -v ./...

Makefile

@@ -42,10 +42,4 @@ pre-push:
 	go mod tidy
 	make lint
 	make test
-	make build
-
-.PHONY: test-changes
-test-changes:
-	git diff --name-only --cached --diff-filter=ACM | grep -E '\.go$$' | xargs -n 1 gofmt -w
-	git diff --cached --name-only --diff-filter=ACM | grep -E '\.go$$' | xargs -n 1 go vet
-	git diff --cached --name-only --diff-filter=ACM | grep -E '\.go$$' | xargs -n 1 go test -v
+	make build

README.md

@@ -0,0 +1,179 @@
+# Image Vault
+
+[![Lint](https://github.com/askolesov/image-vault/actions/workflows/lint.yaml/badge.svg)](https://github.com/askolesov/image-vault/actions/workflows/lint.yaml)
+[![Test](https://github.com/askolesov/image-vault/actions/workflows/test.yaml/badge.svg)](https://github.com/askolesov/image-vault/actions/workflows/test.yaml)
+[![Version](https://img.shields.io/github/v/release/askolesov/image-vault?include_prereleases)](https://github.com/askolesov/image-vault/releases)
+
+Image Vault is a powerful command-line tool specifically designed for managing and organizing photo libraries. It provides photographers and photo enthusiasts with features for initializing photo libraries, adding and organizing image files, verifying library integrity, and displaying detailed photo metadata.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Initializing a Photo Library](#initializing-a-photo-library)
+  - [Adding Photos](#adding-photos)
+  - [Verifying Photo Library Integrity](#verifying-photo-library-integrity)
+  - [Displaying Photo Metadata](#displaying-photo-metadata)
+  - [Showing Version Information](#showing-version-information)
+- [Configuration](#configuration)
+- [Building from Source](#building-from-source)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Installation
+
+To install Image Vault, use the following command:
+
+```
+go install github.com/askolesov/image-vault/cmd/imv@latest
+```
+
+Alternatively, you can build from source (see [Building from Source](#building-from-source)).
+
+### Required Dependency
+
+Image Vault requires `exiftool` to be installed on your system for handling photo metadata. Below are instructions for installing `exiftool` on different operating systems:
+
+#### Linux
+
+To install `exiftool` on Linux, you can use the package manager for your distribution. For example, on Ubuntu, you can use:
+
+```
+sudo apt install libimage-exiftool-perl
+```
+
+#### Windows
+
+To install `exiftool` on Windows using Homebrew, first ensure you have Homebrew installed, then run:
+
+```
+brew install exiftool
+```
+
+## Usage
+
+Image Vault offers several commands to manage your photo library efficiently. Here are the main commands and their usage:
+
+### Initializing a Photo Library
+
+To initialize a new Image Vault photo library in the current directory:
+
+```
+imv init
+```
+
+This command creates a configuration file (`image-vault.yaml`) in the current directory, setting up the structure for your photo organization.
+
+### Adding Photos
+
+To add photos to your library:
+
+```
+imv add <path_to_photos>
+```
+
+This command processes the photos at the specified path, organizes them according to the configured template (which can include metadata like date taken, camera model, etc.), and adds them to the library.
+
+### Verifying Photo Library Integrity
+
+To verify the integrity of your photo library:
+
+```
+imv verify
+```
+
+This command checks all photos in the library to ensure they are properly organized and match their expected locations based on their metadata and the configured template.
+
+### Displaying Photo Metadata
+
+To show detailed metadata for a specific photo:
+
+```
+imv info <photo_path>
+```
+
+This command displays comprehensive metadata information for the specified photo, including camera settings, date taken, and other EXIF data.
+
+### Showing Version Information
+
+To display version information about Image Vault:
+
+```
+imv version
+```
+
+## Configuration
+
+Image Vault uses a YAML configuration file (`image-vault.yaml`) to customize its behavior. Here's an example of the default configuration:
+
+```yaml
+template: |-
+  {{- $make := or .Exif.Make .Exif.DeviceManufacturer "NoMake" -}}
+  {{- $model := or .Exif.Model .Exif.DeviceModelName "NoModel" -}}
+  {{- $dateTimeOriginal := and (any .Exif.DateTimeOriginal) (ne .Exif.DateTimeOriginal "0000:00:00 00:00:00") | ternary .Exif.DateTimeOriginal "" -}}
+  {{- $mediaCreateDate := and (any .Exif.MediaCreateDate) (ne .Exif.MediaCreateDate "0000:00:00 00:00:00") | ternary .Exif.MediaCreateDate "" -}}
+  {{- $date := or $dateTimeOriginal $mediaCreateDate "1970:01:01 00:00:00" | toDate "2006:01:02 15:04:05" -}}
+  {{- $mimeType := .Exif.MIMEType | default "unknown/unknown" | splitList "/" | first -}}
+  {{$make}} {{$model}} ({{$mimeType}})/{{$date | date "2006"}}/{{$date | date "2006-01-02"}}/{{$date | date "2006-01-02_15-04-05"}}_{{.Hash.Md5Short}}{{.Fs.Ext | lower}}
+
+skipPermissionDenied: true
+
+ignore:
+  - image-vault.yaml
+  - .*
+
+sidecarExtensions:
+  - "*.xmp"
+  - "*.yaml"
+  - "*.json"
+```
+
+You can modify this configuration to suit your photo organization needs. The `template` field is particularly important as it determines how your photos will be organized in the library based on their metadata.
+
+## Building from Source
+
+To build Image Vault from source:
+
+1. Clone the repository:
+   ```
+   git clone https://github.com/askolesov/image-vault.git
+   ```
+
+2. Navigate to the project directory:
+   ```
+   cd image-vault
+   ```
+
+3. Build the project:
+   ```
+   make build
+   ```
+
+   This will create the `imv` binary in the `build/` directory.
+
+4. (Optional) Install the binary:
+   ```
+   make install
+   ```
+
+## Contributing
+
+Contributions to Image Vault are welcome! Please feel free to submit pull requests, create issues, or suggest improvements.
+
+Before submitting a pull request, please ensure that:
+
+1. Your code passes all tests:
+   ```
+   make test
+   ```
+
+2. Your code passes the linter:
+   ```
+   make lint
+   ```
+
+3. You've added tests for any new functionality.
+
+## License
+
+// TODO: add license

go.mod

@@ -1,6 +1,6 @@
 module github.com/askolesov/image-vault
 
-go 1.21.2
+go 1.23
 
 require (
 	github.com/Masterminds/sprig/v3 v3.3.0