Skip to content

Commit

Permalink
readme: exit maintenance mode, add logo, contributing (#416)
Browse files Browse the repository at this point in the history
  • Loading branch information
tjex authored May 26, 2024
1 parent cfa74a7 commit e21519a
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 36 deletions.
44 changes: 8 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,11 @@
<div align="center">
<h1>zk</h1>
<img alt="zk logo" width="20%" src="./docs/assets/media/zk-black-modern.png" />
<h4>A plain text note-taking assistant</h4>
<img alt="Screencast" width="95%" src="docs/assets/media/screencast.svg"/>
</div>

Looking for a quick usage example? [Let's get started](docs/getting-started.md).

## News: We Are In Maintenance Mode


> [!IMPORTANT]
> As of January 2nd, the original brain behind zk, [Mickaël
> Menu](https://github.com/mickael-menu), made the difficult decision to retire
> from zk and the suite of programs supporting it. He put out a [call for
> maintainers](https://github.com/zk-org/zk/discussions/371), which has
> garnerned enough response to enable the project to continue! So zk is
> definitely still here for you.
>
> During this transition phase, we are placing the project into a maintenance
> mode, which means we are going to address existing issues and any teething
> problems with transferring the code bases to the new
> [zk-org](https://github.com/zk-org) organisation, which is where you can now
> find all the related projects. It also gives us new maintainers the space to
> get up to speed with the code base, which will help us address new issues and
> feature requests when they come.
>
> So for now, feel free to lodge new issues, but please withold on feature
> requests until we are out of maintenance mode. This will help keep our issues
> boards concise and pr's easier to manage.
>
> The [call to maintainers](https://github.com/zk-org/zk/discussions/371) is
> still open. Please comment there if you feel commited enough to come onboard!
> PR's, ideas, discussions and conversations are still and always will be
> warmly welcomed, with or without 'maintainer' status ❤️

## Description

Expand All @@ -44,7 +17,7 @@ Looking for a quick usage example? [Let's get started](docs/getting-started.md).
* [Advanced search and filtering capabilities](docs/note-filtering.md) including [tags](docs/tags.md), links and mentions
* [Integration with your favorite editors](docs/editors-integration.md):
* [Any LSP-compatible editor](docs/editors-integration.md)
* [`zk-nvim`](https://github.com/zk-org/zk-nvim) for Neovim 0.5+
* [`zk-nvim`](https://github.com/zk-org/zk-nvim) for Neovim 0.8+
* [`zk-vscode`](https://github.com/zk-org/zk-vscode) for Visual Studio Code
* (*unmaintained*) [`zk.nvim`](https://github.com/megalithic/zk.nvim) for Neovim 0.5+ by [Seth Messer](https://github.com/megalithic)
* [Interactive browser](docs/tool-fzf.md), powered by `fzf`
Expand Down Expand Up @@ -99,26 +72,25 @@ sudo pacman -S zk

### Build from scratch

Make sure you have a working [Go 1.18+ installation](https://golang.org/), then clone the repository:
Make sure you have a working [Go 1.21+ installation](https://golang.org/), then clone the repository:

```sh
$ git clone https://github.com/zk-org/zk.git
$ cd zk
```

#### On macOS
#### On macOS / Linux

```
$ make
$ ./zk -h
```

#### On Linux
## Contributing

```
$ make
$ ./zk -h
```
We warmly welcome issues, PRs and [discussions](https://github.com/zk-org/zk/discussions).

Here you can read [some useful info for contributing to `zk`](./CONTRIBUTING.md).

## Related projects

Expand Down
Binary file added docs/assets/media/zk-black-modern.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e21519a

Please sign in to comment.