aboutsummaryrefslogtreecommitdiff
path: root/package-summary.md
diff options
context:
space:
mode:
Diffstat (limited to 'package-summary.md')
-rw-r--r--package-summary.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/package-summary.md b/package-summary.md
new file mode 100644
index 0000000..894840d
--- /dev/null
+++ b/package-summary.md
@@ -0,0 +1,28 @@
+### Brief summary of what the package does
+
+pearl integrates Linear.app issue tracking with Emacs and org-mode. It fetches your issues — open issues, a project, an ad-hoc filter, a Linear Custom View, or a named saved query — into a single self-describing org file: each issue is a heading, its description and comments render in the body, and its structured fields live in a namespaced property drawer. You can edit a description, title, or your own comments and push them back with conflict-aware sync, set priority/state/assignee/labels by command, add comments, and create or delete issues, all without leaving Emacs. A transient menu (`M-x pearl-menu`) gathers every command.
+
+### Direct link to the package repository
+
+https://github.com/cjennings/pearl
+
+### Your association with the package
+
+I am the author and maintainer. pearl is based on and inspired by Gael Blanchemain's linear-emacs (GPL-3.0).
+
+### Relevant communications with the upstream package maintainer
+
+None needed — pearl is a renamed, independently maintained derivative of the GPL-3.0 linear-emacs.
+
+### Checklist
+
+<!-- Please confirm by replacing `[]` with `[x]`: -->
+
+- [x] The package is released under a [GPL-Compatible Free Software License](https://www.gnu.org/licenses/license-list.en.html#GPLCompatibleLicenses)
+- [] I've read [CONTRIBUTING.org](https://github.com/melpa/melpa/blob/master/CONTRIBUTING.org)
+- [x] I've used the latest version of [package-lint](https://github.com/purcell/package-lint) to check for packaging issues, and addressed its feedback
+- [x] My elisp byte-compiles cleanly
+- [x] I've used `M-x checkdoc` to check the package's documentation strings
+- [] I've built and installed the package using the instructions in [CONTRIBUTING.org](https://github.com/melpa/melpa/blob/master/CONTRIBUTING.org)
+
+<!-- After submitting, please fix any problems the CI reports. -->