Skip to content

Commit

Permalink
shuffle install instructions + add badges to doc site
Browse files Browse the repository at this point in the history
  • Loading branch information
jinnovation committed Jan 9, 2023
1 parent c54c471 commit 5639a4b
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 12 deletions.
2 changes: 1 addition & 1 deletion .docstyle.rb
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

rule "ul-style", style: :dash
rule "no-duplicate-header", allow_different_nesting: true
rule "line-length", :line_length => 120
rule "line-length", :line_length => 130

exclude_rule 'MD024' # Multiple headers with the same content
exclude_rule 'MD026' # Trailing punctuation in header
2 changes: 1 addition & 1 deletion README.org
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ configs.

#+begin_src emacs-lisp
(use-package kele
:straight (kele :type git :host github :repo "jinnovation/kele.el")
:straight t
:config
(kele-mode 1))
#+end_src
Expand Down
24 changes: 14 additions & 10 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# 🥤 kele.el (Kubernetes Enablement Layer for Emacs)

[![MELPA](https://melpa.org/packages/kele-badge.svg)](https://melpa.org/#/kele)
[![MELPA Stable](https://stable.melpa.org/packages/kele-badge.svg)](https://stable.melpa.org/#/kele)
[![License](https://img.shields.io/github/license/jinnovation/kele.el)](https://github.com/jinnovation/kele.el/blob/main/LICENSE)

![](./img/kele.jpg)

Kele (*kě lè*, or *kə-ˈlə*) ("Kubernetes Enablement Layer for Emacs") is a
Expand All @@ -23,13 +27,13 @@ e.g. [Embark], that you can take advantage of in your own configs.

## Getting Started

=== "The Hard Way"

Clone this repository and put it in your load-path.
=== "Use-package + Straight"

```emacs-lisp
(require 'kele)
(kele-mode 1)
(use-package kele
:straight t
:config
(kele-mode 1))
```

=== "Use-package"
Expand All @@ -47,13 +51,13 @@ e.g. [Embark], that you can take advantage of in your own configs.
(kele-mode 1)
```

=== "Use-package + Straight"
=== "The Hard Way"

Clone this repository and all dependencies and put them in your load-path.

```emacs-lisp
(use-package kele
:straight t
:config
(kele-mode 1))
(require 'kele)
(kele-mode 1)
```

## Design Ethos
Expand Down

0 comments on commit 5639a4b

Please sign in to comment.