Add README

README.md

@@ -0,0 +1,68 @@
+# gh-md: markdown link and issue reference generation
+
+This [GitHub CLI](https://cli.github.com) extension generates markdown links from input URLs or references.
+
+This isn't particularly useful by itself, but combine it with tools like [Alfred](https://alfred.app) snippet triggers, [Raycast](https://www.raycast.com) scripts, or [Obsidian](https://obsidian.md) templates, you can automate these links for insertion into your markdown documents.
+
+## Installation
+
+`gh extension install zerowidth/gh-md`
+
+## Usage
+
+`gh md --help` for full details.
+
+### `gh md link`
+
+Generates a markdown link from an input URL or issue/pr/discussion reference.
+
+Basic example:
+
+```
+$ gh md link https://github.com/cli/cli/pull/123
+[cli/cli#123: Tweak flags language](https://github.com/cli/cli/pull/123)
+```
+
+Skip title lookup:
+
+```
+$ gh md link --simple https://github.com/cli/cli/pull/123
+[cli/cli#123](https://github.com/cli/cli/pull/123)
+```
+
+Create a link from an issue reference:
+
+```
+$ gh md link cli/cli#123
+[cli/cli#123: Tweak flags language](https://github.com/cli/cli/pull/123)
+```
+
+In Obsidian, setting this up as a user-defined function in the [Templater](https://github.com/SilentVoid13/Templater) plugin:
+
+- define `markdownLink` as `/path/to/gh md link $input`
+- copy a GitHub URL to your clipboard
+- use it in a template: `<% tp.user.markdownLink({input: (await tp.system.clipboard())}) %>`
+
+### `gh md ref`
+
+Generates an issue/pr/discussion reference from an input URL or reference.
+
+```
+$ gh md ref https://github.com/cli/cli/pull/123
+cli/cli#123
+```
+
+### `gh md title`
+
+Looks up the title of the given URL or reference:
+
+```
+$ gh md title cli/cli#123
+Tweak flags language
+```
+
+The title can be sanitized for use as a path, stripping `:`, `/`, and a few other characters. For example, in Obsidian templater, define `markdownTitle` as `/path/to/gh md title --sanitize $input`. After copying a GitHub url to your clipboard, you can use this in a file template like:
+
+```
+<%- await tp.file.rename("Issue - " + tp.date.now("YYYY-MM") + " - " + (await tp.user.markdownTitle({input: (await tp.system.clipboard())}))) -%>
+```