1 files changed, 48 insertions, 0 deletions

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..9441840
--- /dev/null
+++ b/README.org
@@ -0,0 +1,48 @@
+* Overview
+=elfeed-custom-feeds= provides custom feed generators for [[https://github.com/skeeto/elfeed][elfeed]],
+allowing you to monitor:
+- HuggingFace organization model releases
+- GitHub pull requests with custom search queries
+
+This package extends =elfeed= beyond traditional RSS/Atom feeds to
+track content from platforms that don't provide native feeds.
+
+* Installation
+** Using elpaca (local development)
+#+begin_src emacs-lisp
+  (use-package elfeed-custom-feeds
+    :ensure (:host "git.vineetk.net" :repo "vin/elfeed-custom-feeds")
+    :after elfeed
+    :custom
+    (elfeed-custom-huggingface-orgs '("sentence-transformers" "google-bert"))
+    (elfeed-custom-github-pr-queries 
+     '(("emacs-mirror/emacs" "" "Emacs")
+       ("atlas-engineer/nyxt" "is:open" "Nyxt")
+       ("qutebrowser/qutebrowser" "label:\"bug: behavior\"" "qutebrowser behavior bug")))
+    :hook
+    (elfeed-update . elfeed-custom-feeds-update-all))
+#+end_src
+
+** Manual installation
+Clone the repository and add to your load path:
+#+begin_src emacs-lisp
+(add-to-list 'load-path "~/path/to/elfeed-custom-feeds")
+(require 'elfeed-custom-feeds)
+#+end_src
+
+* Usage
+** Update all feeds
+#+begin_src emacs-lisp
+M-x elfeed-custom-feeds-update-all
+#+end_src
+
+** Update specific feed types
+Update only HuggingFace feeds:
+#+begin_src emacs-lisp
+M-x elfeed-custom-feeds-hf-update
+#+end_src
+
+Update only GitHub PR feeds:
+#+begin_src emacs-lisp
+M-x elfeed-custom-feeds-github-update
+#+end_src