Skip to content

Rewrite the README around an example - #262

Merged
lyrixx merged 1 commit into
mainfrom
readme
Oct 14, 2026
Merged

lyrixx merged 1 commit into
mainfrom
readme

Conversation

@lyrixx

@lyrixx lyrixx commented Oct 14, 2026 •

Copy link
Copy Markdown
Member

The README opened on the drivers, then on installing gitlib, before any code. It now goes:

  1. one line on what gitlib is;
  2. an example reading a log, a diff and a blame, which runs as it is (checked on this repository);
  3. a link to the site;
  4. what gitlib does, each item linking to its documentation;
  5. the two drivers, and when LibGit2Driver is worth it;
  6. installation, the upgrade guide and the changelog;
  7. the documentation pages, in the order of the site, Tidelift, and the license.

No claim the documentation doesn't back. The README is also the home page of the site: it builds in strict mode, its links included.

The README opened on the drivers, then installing gitlib, before any
code. It now starts with a line on what gitlib is, and an example
reading a log, a diff and a blame, which runs as it is. Then what gitlib
does, with links to the documentation, its site, the two drivers, how to
install it, and the license.
@lyrixx
lyrixx merged commit a8f6b3b into main Oct 14, 2026
13 checks passed
@lyrixx
lyrixx deleted the readme branch October 14, 2026 15:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant