Skip to content
This repository has been archived by the owner on Jun 18, 2024. It is now read-only.

Commit

Permalink
docs: Add installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
pojntfx committed Jun 6, 2023
1 parent 2b76f8d commit 885a5c0
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,47 @@ Minimal personal CRM.

🚧 This project is a work-in-progress! Instructions will be added as soon as it is usable. 🚧

## Installation

### Hosted Demo

If you just want to quickly evaluate Donna, check out the hosted demo:

[<img src="https://github.com/pojntfx/webnetesctl/raw/main/img/launch.png" width="240">](https://donna-demo.vercel.app/)

### Containerized

You can get the OCI image like so:

```shell
$ podman pull ghcr.io/pojntfx/donna
```

### Natively

Static binaries are available on [GitHub releases](https://github.com/pojntfx/donna/releases).

On Linux, you can install them like so:

```shell
$ curl -L -o /tmp/donna "https://github.com/pojntfx/donna/releases/latest/download/donna.linux-$(uname -m)"
$ sudo install /tmp/donna /usr/local/bin
```

On macOS, you can use the following:

```shell
$ curl -L -o /tmp/donna "https://github.com/pojntfx/donna/releases/latest/download/donna.darwin-$(uname -m)"
```

On Windows, the following should work (using PowerShell as administrator):

```shell
PS> Invoke-WebRequest https://github.com/pojntfx/donna/releases/latest/download/donna.windows-x86_64.exe -OutFile \Windows\System32\donna.exe
```

You can find binaries for more operating systems and architectures on [GitHub releases](https://github.com/pojntfx/donna/releases).

## Contributing

To contribute, please use the [GitHub flow](https://guides.github.com/introduction/flow/) and follow our [Code of Conduct](./CODE_OF_CONDUCT.md).
Expand Down

1 comment on commit 885a5c0

@vercel
Copy link

@vercel vercel bot commented on 885a5c0 Jun 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

donna – ./

donna-demo.vercel.app
donna-git-main-morniteaque.vercel.app
donna-morniteaque.vercel.app

Please sign in to comment.