Trim down README

[mptre]

• Merge the initial paragraph with usage, now that we can refer to manual

• Limitations of calling pick from within Vim is better of described in the README of pick.vim

/cc @calleerlandsson @teoljungberg @mike-burns

[codecov-io]

Codecov Report

Merging #280 into master will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #280   +/-   ##
=======================================
  Coverage   90.14%   90.14%           
=======================================
  Files           1        1           
  Lines         497      497           
=======================================
  Hits          448      448           
  Misses         49       49

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 254c863...c8b20f8. Read the comment docs.

[mike-burns]

I like it, but I'd prefer to still see at least one usage example in the README to help non-sighted readers understand what it does at a glance. (There's the GIF at the top but that won't help people using a screenreader.)

Just this amount is what I request:

pick(1) reads a list of choices on stdin and outputs the selected choice on stdout. Therefore it is easily used both in pipelines and subshells:

git ls-files | pick | xargs less # Select a file in the current git repository to view in less
cd "$(find . -type d | pick)"    # Select a directory to cd into
eval $(fc -ln 1 | pick)          # Select a command from the history to execute

While here, I like tiny usage snippets like that to go above installation, as a sales pitch to the new potential user.

What do you think?

[calleluks]

I agree with @mike-burns that a tiny bit of usage can be helpful in showing what the program does rather than explaining it. Otherwise, I think this looks great! 🎉

Do I have to do something to make the https://calleerlandsson.github.io/pick/ links work?

[mptre]

Thanks for the feedback!

What do you think?

Makes perfect sense. I made one modification and used the examples from the manual instead.

Do I have to do something to make the https://calleerlandsson.github.io/pick/ links work?

I thought it was a cache issue at first. Check Settings > Options > GitHub Pages > Source and ensure gh-pages is selected.

[mike-burns]

LGTM!

[calleluks]

I thought it was a cache issue at first. Check Settings > Options > GitHub Pages > Source and ensure gh-pages is selected.

gh-pages is the selected branch. According to the docs, this should be enough. Maybe a new commit to the branch will trigger a build?

This PR looks good to merge!

[mptre]

gh-pages is the selected branch. According to the docs, this should be enough. Maybe a new commit to the branch will trigger a build?

Still no luck...

[calleluks]

I turned it off and on again and now it seems to work 🤷‍♂️...

[mptre]

Great! Now merged.