Prepare release v0.0.0.0

.github/workflows/ci.yml

@@ -20,14 +20,14 @@ jobs:
         ghc:
           - "8.10.7"
           - "9.0.2"
-          - "9.2.3"
-        
+          - "9.2.4"
+
         exclude:
           - os: macOS-latest
             ghc: 8.10.7
           - os: macOS-latest
             ghc: 9.0.2
-          
+
           - os: windows-latest
             ghc: 8.10.7
           - os: windows-latest
@@ -79,7 +79,7 @@ jobs:
       strategy:
         matrix:
           stack: ["2.7.5"]
-          ghc: ["9.2.3"]
+          ghc: ["9.2.4"]
 
       steps:
       - uses: actions/checkout@v3

CHANGELOG.md

@@ -1,11 +1,42 @@
 # Changelog
 
-`iris` uses [PVP Versioning][1].
-The changelog is available [on GitHub][2].
+All notable changes to this project will be documented in this file.
 
-## 0.0.0.0
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [PVP Versioning][1]. The changelog is also
+available [on GitHub][2].
 
-* Initially created.
+
+## [Unreleased]
+
+## [0.0.0.0] — 2022-08-09 🌇
+
+Initial release prepared by [@chshersh](https://github.com/chshersh).
+
+### Added
+
+- [#34](https://github.com/chshersh/iris/issues/34):
+  Add the `--no-input` CLI option for disabling interactivity
+  (by [@charrsky](https://github.com/charrsky))
+- [#36](https://github.com/chshersh/iris/issues/36):
+  Support Windows and macOS
+  (by [@charrsky](https://github.com/charrsky))
+- [#37](https://github.com/chshersh/iris/issues/37):
+  Support GHC 9.0.2
+  (by [@charrsky](https://github.com/charrsky))
+- [#38](https://github.com/chshersh/iris/issues/38):
+  Support GHC 9.2.3 and GHC 9.2.4
+  (by [@charrsky](https://github.com/charrsky), [@chshersh](https://github.com/chshersh))
+- [#42](https://github.com/chshersh/iris/issues/42),
+  [#52](https://github.com/chshersh/iris/issues/52):
+  Add `stack` support and instructions to build with `stack`
+  (by [@charrsky](https://github.com/charrsky), [@chshersh](https://github.com/chshersh))
+- [#43](https://github.com/chshersh/iris/issues/43):
+  Add `MonadUnliftIO` instance for the `CliApp` monad
+  (by [@charrsky](https://github.com/charrsky))
 
 [1]: https://pvp.haskell.org
 [2]: https://github.com/chshersh/iris/releases
+
+[Unreleased]: https://github.com/chshersh/iris/compare/v0.0.0.0...HEAD
+[0.0.0.0]: https://github.com/chshersh/iris/releases/tag/v0.0.0.0

README.md

@@ -4,6 +4,12 @@
 [![Hackage](https://img.shields.io/hackage/v/iris.svg?logo=haskell)](https://hackage.haskell.org/package/iris)
 [![MPL-2.0 license](https://img.shields.io/badge/license-MPL--2.0-blue.svg)](LICENSE)
 
+<picture>
+  <source media="(prefers-color-scheme: dark)"  srcset="images/iris-dark.png">
+  <source media="(prefers-color-scheme: light)" srcset="images/iris-light.png">
+  <img alt="Iris changing her workflow and hair colour dependending on the time of day." src="images/iris-dark.png">
+</picture>
+
 **Iris** is a Haskell framework for building CLI applications that follow
 [Command Line Interface Guidelines](https://clig.dev/).
 
@@ -109,30 +115,56 @@ will need to set it up with these steps:
 Check [CONTRIBUTING.md](https://github.com/chshersh/iris/blob/main/CONTRIBUTING.md)
 for contributing guidelines.
 
-## Building the project
+## Development
+
+To build the project and run the tests locally, you can use either
+`cabal` or `stack`.
+
+> See the [First time][#first-time] section if you don't have Haskell
+> development environment locally.
+
+### Cabal
 
-To build the project and run the tests locally, you can use either `cabal` or `stack`:
+Build the project:
 
 ```shell
 cabal build all
+```
+
+Run all unit tests:
+
+```shell
 cabal test --enable-tests --test-show-details=direct
 ```
 
-or
+### Stack
+
+Build the project:
+
+```shell
+stack build --test --no-run-tests
+```
+
+Run all unit tests:
 
 ```shell
-stack build
 stack test
 ```
 
-If this is your first time dealing with Haskell tooling, we recommend using GHCup (which you can get [here](https://www.haskell.org/ghcup/)) for the initial setup.
+### First time
+
+If this is your first time dealing with Haskell tooling, we recommend
+using [GHCup](https://www.haskell.org/ghcup/).
 
-During the installation, GHCup will suggest you installing all the necessary tools. If you have GHCup installed but miss some of the tooling for some reason, just enter
+During the installation, GHCup will suggest you installing all the
+necessary tools. If you have GHCup installed but miss some of the
+tooling for some reason, type the following commands in the terminal:
 
 ```shell
-ghcup install <tool>
+ghcup install ghc 8.10.7
+ghcup set     ghc 8.10.7
+ghcup install cabal 3.6.2.0
 ```
 
-into the terminal.
-
-(Also, if you are using Linux or macOS, you may find `ghcup tui` command a more attractive option.)
+> If you are using Linux or macOS, you may find `ghcup tui` command a
+> more attractive option.

iris.cabal

@@ -16,9 +16,9 @@ category:            CLI,Framework
 build-type:          Simple
 extra-doc-files:     README.md
                      CHANGELOG.md
-tested-with:         GHC == 8.10.7
+tested-with:         GHC == 9.2.4
                      GHC == 9.0.2
-                     GHC == 9.2.3
+                     GHC == 8.10.7
 
 source-repository head
   type:                git
@@ -78,8 +78,8 @@ library
       Iris.Browse
       Iris.Cli
         Iris.Cli.Browse
-        Iris.Cli.Version
         Iris.Cli.Interactive
+        Iris.Cli.Version
       Iris.Colour
         Iris.Colour.Formatting
         Iris.Colour.Mode

stack.yaml

@@ -1,4 +1,4 @@
-resolver: nightly-2022-07-23
+resolver: nightly-2022-08-04
 
 extra-deps:
   - github: uhbif19/colourista