Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: readme refresh #228

Merged
merged 2 commits into from
Feb 15, 2023
Merged

docs: readme refresh #228

merged 2 commits into from
Feb 15, 2023

Conversation

jamestrew
Copy link
Collaborator

Tweaking the readme based on some feedback & common areas on confusion I've been seeing in the issues.

Main changes:

  • Added lua table for default options people can copy/paste into their config and tweak for hopefully better discoverability of options.
  • Added example keymapping for opening the file browser in the current buffer path
  • Reordered sections to bring mappings closer to the usage section

One #210 and #222 are completed, we'll probably want to update the demo gif/mp4s. I can also work on that when the time comes.

@jamestrew jamestrew merged commit 9c2ff3b into master Feb 15, 2023
@jamestrew jamestrew deleted the docs/readme-refresh branch February 15, 2023 06:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant