From 5639a4b8ab054123dd596eb920466db9979d4371 Mon Sep 17 00:00:00 2001 From: Jonathan Jin Date: Mon, 9 Jan 2023 14:27:04 -0500 Subject: [PATCH] shuffle install instructions + add badges to doc site --- .docstyle.rb | 2 +- README.org | 2 +- docs/index.md | 24 ++++++++++++++---------- 3 files changed, 16 insertions(+), 12 deletions(-) diff --git a/.docstyle.rb b/.docstyle.rb index c75ad75..e24ccdf 100644 --- a/.docstyle.rb +++ b/.docstyle.rb @@ -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 diff --git a/README.org b/README.org index 9e9e35e..5dbd34a 100644 --- a/README.org +++ b/README.org @@ -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 diff --git a/docs/index.md b/docs/index.md index e89a948..35f0ee0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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 @@ -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" @@ -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