Skip to content

Commit

Permalink
docs: Move installation to the top
Browse files Browse the repository at this point in the history
  • Loading branch information
staticaland committed Mar 16, 2023
1 parent b3d28df commit 4671ec9
Showing 1 changed file with 26 additions and 29 deletions.
55 changes: 26 additions & 29 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,32 @@ I like [GitHub: Where the world builds software · GitHub](https://github.com)
Inspired by [[http://brettterpstra.com/2015/02/18/titler-system-service/][Titler by Brett Terpstra]] for Mac OS and [[https://github.com/rexim/org-cliplink][org-cliplink]] for Emacs.


* Installation

[[https://github.com/staticaland/go-whaturl/releases][Check out releases for pre-built binaries]].

A Homebrew formula is included at [[./Formula/whaturl.rb][Formula/whaturl.rb]].

#+begin_src sh
brew tap staticaland/go-whaturl https://github.com/staticaland/go-whaturl
brew install whaturl
#+end_src

If you watch the project (Watch → Custom → Releases) you can easily upgrade to
the latest version when notified:

#+begin_src sh
brew upgrade whaturl
#+end_src

To uninstall:

#+begin_src sh
brew uninstall whaturl
brew untap staticaland/go-whaturl
#+end_src


* Usage

#+begin_src sh :wrap src sh :results raw :exports results
Expand Down Expand Up @@ -92,35 +118,6 @@ vnoremap <leader>l :!whaturl<CR>
This is reminiscent of the [[https://blog.sanctum.geek.nz/vim-koans/][Vim Kōan Master Wq and the Markdown acolyte]].


* Installation

[[https://github.com/staticaland/go-whaturl/releases][Check out releases for pre-built binaries]].


** Homebrew

A Homebrew formula is included at [[./Formula/whaturl.rb][Formula/whaturl.rb]].

#+begin_src sh
brew tap staticaland/go-whaturl https://github.com/staticaland/go-whaturl
brew install whaturl
#+end_src

If you watch the project (Watch → Custom → Releases) you can easily upgrade to
the latest version when notified:

#+begin_src sh
brew upgrade whaturl
#+end_src

To uninstall:

#+begin_src sh
brew uninstall whaturl
brew untap staticaland/go-whaturl
#+end_src


* Build and run

#+begin_html
Expand Down

0 comments on commit 4671ec9

Please sign in to comment.