summaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
Diffstat (limited to 'README.org')
-rw-r--r--README.org9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..632253b
--- /dev/null
+++ b/README.org
@@ -0,0 +1,9 @@
+#+TITLE: ol-file-paged
+#+SUBTITLE: Org file links with associated page number
+
+* =ol-file-paged=
+/Org file links with associated page number./
+
+=ol-file-paged= introduces a new type of link to Org-mode. It is a =file:= link that also encodes a page number, making it suitable for referring to paged media such as PDFs. It currently integrates with the built-in =doc-view-mode= and =pdf-tools=. Please read the package’s description and function docstrings to learn how to use it.
+
+*Warning: This project is still version < 1.0, and is therefore /not guaranteed to be stable/. I maintain it for myself, but do not have capacity to improve or test it beyond my needs.* If you find a bug, feel free to report it, but don’t expect there not to be any.