ajour 1.0.1

<!-- markdownlint-disable MD004 MD033 -->

<div align="center">

# Ajour

![Continuous integration](https://github.com/ajour/ajour/workflows/Continuous-integration/badge.svg)
![Security audit](https://github.com/ajour/ajour/workflows/Security%20audit/badge.svg)
[![Discord Server](https://img.shields.io/discord/757155234500968459?label=Discord%20Chat&labelColor=3C424A&logo=discord&logoColor=ffffff&color=7389D8)](https://discord.gg/4838t9R)
[![Ajour on Patreon](https://img.shields.io/static/v1?label=Patreon&message=Ajour&color=4d898b)](https://www.patreon.com/getajour)

![ajour banner](./resources/screenshots/ajour-banner.jpg)

</div>

## Table of Contents

- [Introduction](#introduction)
- [Screenshots](#screenshots)
- [Features](#features)
- [Install](#install)
- [Themes](#themes)
- [Command Line](#command-line)
- [Contribute](#contribute)
- [FAQ](#faq)
- [Acknowledgement](#acknowledgement)

## Introduction

Ajour is a World of Warcraft addon manager written in Rust with a strong focus
on performance and simplicity. The project is completely advertisement free, privacy
respecting and open source. Ajour currently supports Windows, macOS and Linux.

<div align="center">

[![Download Button](./resources/download-button.png)](https://github.com/ajour/ajour/releases)

</div>

## Screenshots

<p align="center">
  <img width="410"
       alt="Ajour showing addons"
       src="./resources/screenshots/ajour-1.0.0a.png">
    <img width="410"
       alt="Ajour showing catalog"
       src="./resources/screenshots/ajour-1.0.0b.png">
</p>

## Features

- Addons will be parsed automatically and resolved from multiple repositories:
  - [Tukui](https://www.tukui.org/)
  - [CurseForge](https://www.curseforge.com/wow/addons)
  - [WoWInterface](https://www.wowinterface.com/)
  - [Townlong Yak](https://www.townlong-yak.com/)
- Install new addons from the catalog or directly from a GitHub/GitLab URL
- Support for release channels, so it's possible to select either `alpha`, `beta`
  or `stable` for each addon
- View changelogs for each addon
- Bulk addon update without any limitations
- Remove addons and their dependencies
- Ignore addons you don't want to update
- Supports both Retail, Classic, PTR and Beta versions of World of Warcraft
- 10+ handcrafted themes to choose between
  - [Ability to add your own custom themes](./THEMES.md)
- Ability to backup your whole UI, including all settings from WTF
- Ability to run as a [command line application](#command-line) for advanced users
- WeakAuras and Plater import strings from [Wago.io](https://wago.io/) will automatically
  be parsed
- Localized in multiple languages

## Install

Prebuilt binaries for macOS and Windows can be downloaded from the [GitHub releases](https://github.com/ajour/ajour/releases)
page.

For everyone else, a detailed instruction can be found [here](https://github.com/ajour/ajour/blob/master/INSTALL.md).

## Themes

Find instructions for building your own themes [here](./THEMES.md).

## Command Line

Find instructions for using the command line interface [here](./CLI.md)

## Contribute

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)

Ajour wouldn't be here without your help.
I welcome contributions of any kind, because together we can make Ajour even better.

- [Let me know](https://github.com/ajour/ajour/issues/new?assignees=&labels=type%3A+feature&template=feature_request.md&title=)
  if you are missing a vital feature.
- I love [pull requests](https://github.com/ajour/ajour/pulls) and [bug reports](https://github.com/ajour/ajour/issues/new?assignees=&labels=type%3A+bug&template=bug_report.md&title=).
- Don't hesitate to [tell me my Rust programming is bad](https://github.com/ajour/ajour/issues/new)
  but please tell me why.
- Help translating Ajour on [POEditor](https://poeditor.com/join/project?hash=gjghTR7d0Z).
- Join our [Discord server](https://discord.gg/4838t9R) and say hey.

## FAQ

**_What features are planned?_**

We have a roadmap [here](https://github.com/ajour/ajour/projects/2).

**_macOS won't let me open the app, what should I do?_**

Instead of double clicking it, right click and choose "Open". That should successfully
open Ajour.

**_What requirements does Ajour have?_**

Windows: DX12 or Vulkan
Linux: Vulkan
macOS: Metal

If you are having problems with these requirements, then try the OpenGL build.

**_Where does Ajour store its configuration?_**

Ajour will generate a folder in the following directory:

macOS / Linux:

- `$HOME/.config/ajour`

Windows:

- `%APPDATA%\ajour`

Inside this folder Ajour will keep a configuration file for storing different user
settings, a log file with events from the last session, a fingerprint file with
hashed fingerprints for each addon and a theme folder with custom themes.

**_Why Rust?_**

We wanted to create an application which natively compiles to both Windows, Linux
and macOS while at the same time is as performant and reliable as possible.

## Other addon managers

If Ajour isn't your cup of tea, then [Ogri'la](https://github.com/ogri-la) has
done a great job of [cataloguing addon managers](https://ogri-la.github.io/wow-addon-managers/).

## Acknowledgement

- [Rasmus Nielsen](https://rasmusnielsen.dk/) for the Ajour icon.
- [Rune Seir](https://instagram.com/rseir/) for the Ajour banner.

## License

Ajour is released under the [MIT License.](https://github.com/ajour/ajour/blob/master/LICENSE)