From 57ce4e04171611299c435c3bd8af5eef710357b0 Mon Sep 17 00:00:00 2001
From: Dakota Walsh <kota@nilsu.org>
Date: Mon, 22 Aug 2022 19:50:53 +1200
Subject: [PATCH] add example to README

---
 README.md | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

diff --git a/README.md b/README.md
index 7dedbd6..c04af86 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,48 @@
 # Star
 Display some information about a github or sourcehut repository.
 
+Enter something like this into STDIN:
+```
+https://github.com/ange-yaghi/engine-sim      
+https://github.com/aadv1k/gdoc.vim
+https://github.com/anuvyklack/hydra.nvim
+https://github.com/uga-rosa/cmp-dictionary
+https://github.com/f3fora/cmp-spell
+```
+
+And get something like this:
+```
+https://github.com/ange-yaghi/engine-sim
+Desc: Combustion engine simulator that generates realistic audio.
+Lang: C++
+Stars: 3571
+
+https://github.com/Aadv1k/gdoc.vim
+Desc: Google docs integration for vim
+Lang: Python
+Stars: 37
+Topics: google-docs, google-docs-api, neovim, neovim-plugin, python, python-3,
+python3, vim, vim-configuration, vim-plug, vim-plugin, viml, vimrc
+
+https://github.com/anuvyklack/hydra.nvim
+Desc: Create custom submodes and menus
+Lang: Lua
+Stars: 544
+Topics: lua, neovim, neovim-plugin
+
+https://github.com/uga-rosa/cmp-dictionary
+Desc: nvim-cmp source for dictionary.
+Lang: Lua
+Stars: 103
+Topics: lua, neovim-plugin, nvim-cmp
+
+https://github.com/f3fora/cmp-spell
+Desc: spell source for nvim-cmp based on vim's spellsuggest.
+Lang: Lua
+Stars: 82
+Topics: nvim-cmp
+```
+
 # Build and Install
 ```sh
 make
-- 
2.45.2