chore: add readme and CI

.github/workflows/melpazoid.yml

@@ -0,0 +1,30 @@
+# melpazoid <https://github.com/riscy/melpazoid> build checks.
+
+# If your package is on GitHub, enable melpazoid's checks by copying this file
+# to .github/workflows/melpazoid.yml and modifying RECIPE and EXIST_OK below.
+
+name: melpazoid
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v1
+      with: { python-version: 3.9 }
+    - name: Install
+      run: |
+        python -m pip install --upgrade pip
+        sudo apt-get install emacs && emacs --version
+        git clone https://github.com/riscy/melpazoid.git ~/melpazoid
+        pip install ~/melpazoid
+    - name: Run
+      env:
+        LOCAL_REPO: ${{ github.workspace }}
+        # RECIPE is your recipe as written for MELPA:
+        RECIPE: (buffer-hop :repo "artawower/buffer-hop.el" :fetcher github)
+        # set this to false (or remove it) if the package isn't on MELPA:
+        EXIST_OK: true
+      run: echo $GITHUB_REF && make -C ~/melpazoid

README.org

@@ -0,0 +1,36 @@
+:PROPERTIES:
+:ID: buffer-hop.el
+:END:
+
+#+TITLE: buffer-hop.el
+
+#+html: <span class="badge-buymeacoffee">
+#+html: <a href="https://www.paypal.me/darkawower" title="Paypal" target="_blank"><img src="https://img.shields.io/badge/paypal-donate-blue.svg" alt="Buy Me A Coffee donate button" /></a>
+#+html: </span>
+#+html: <span class="badge-patreon">
+#+html: <a href="https://patreon.com/artawower" target="_blank" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-orange.svg" alt="Patreon donate button" /></a>
+#+html: </span>
+#+html: <a href="https://wakatime.com/badge/github/Artawower/buffer-hop.el"><img src="https://wakatime.com/badge/github/Artawower/buffer-hop.el.svg" alt="wakatime"></a>
+#+html: <a href="https://github.com/artawower/buffer-hop.el/actions/workflows/melpazoid.yml/badge.svg"><img src="https://github.com/artawower/buffer-hop.el/actions/workflows/melpazoid.yml/badge.svg" alt="ci" /></a>
+
+
+Package for quick navigation between visited buffers.
+
+*IMPORTANT* it's a prototype, it could be buggy a bit.
+
+* ⚙️ Install
+*** Straight
+#+BEGIN_SRC emacs-lisp
+(use-package buffer-hop
+  :straight (:host github :repo "artawower/buffer-hop.el")
+  :bind (:map evil-normal-state-map
+              ("SPC ]" . buffer-hop-next)
+              ("SPC [" . buffer-hop-prev)
+              ("SPC br" . buffer-hop-jump-to-recently-buffer))
+  :config
+  (setq buffer-hop-ignored-buffers-patterns '("^\\*" "^magit" "^COMMIT_EDITMSG"))
+  (setq buffer-hop-disabled-modes '(minibuffer-mode dired-mode))
+  (setq buffer-hop-always-allowed-buffers-patterns)
+  (global-buffer-hop-mode))
+  #+END_SRC
+