Skip to content

Commit

Permalink
docs: Update documents
Browse files Browse the repository at this point in the history
  • Loading branch information
liquidz committed Nov 3, 2024
1 parent 5558a1e commit c1e91fb
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
14 changes: 8 additions & 6 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,19 @@ A Clojure development environment for Vim/Neovim and more!, primarily written in

image:https://github.com/liquidz/elin/workflows/test/badge.svg["GitHub Actions for test workflow", link="https://github.com/liquidz/elin/actions?query=workflow%3Atest"]

== 🤖 Work in progress

This project is a work in progress. The APIs and behaviors are not stable and may change in the future.

== 🌱 Requirements

* https://github.com/vim/vim[Vim] v9.1 or later, https://github.com/neovim/neovim[Neovim] v0.9.5 or later
* https://github.com/babashka/babashka[Babashka] v1.3.189 or later
* https://github.com/vim/vim[Vim] v9.1 or later, https://github.com/neovim/neovim[Neovim] v0.10.0 or later
* https://github.com/babashka/babashka[Babashka] v1.12.194 or later
* https://github.com/clj-kondo/clj-kondo[Clj-kondo] (Optional but highly recommended)

== 🤖 Work in progress

This project is a work in progress. The APIs and behaviors are not stable and may change in the future.
== 📗 Documentation

See link:./doc/elin.txt[help] for example configurations.
* https://liquidz.github.io/elin/

== 🍃 Related works

Expand Down
4 changes: 2 additions & 2 deletions doc/pages/getting_started/index.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
=== Requirements

* https://github.com/vim/vim[Vim] v9.1 or later, https://github.com/neovim/neovim[Neovim] v0.9.5 or later
* https://github.com/babashka/babashka[Babashka] v1.3.189 or later
* https://github.com/vim/vim[Vim] v9.1 or later, https://github.com/neovim/neovim[Neovim] v0.10.0 or later
* https://github.com/babashka/babashka[Babashka] v1.12.194 or later
* https://github.com/clj-kondo/clj-kondo[Clj-kondo] (Optional but highly recommended)
=== Installation
Expand Down

0 comments on commit c1e91fb

Please sign in to comment.