supergit: add logo and rebuild README

wip/yesman
Katharina Fey 3 years ago
parent c3d64b9be3
commit 3ca87e463a
  1. 8
      apps/servers/octopus/supergit/Cargo.toml
  2. 34
      apps/servers/octopus/supergit/README.md
  3. BIN
      apps/servers/octopus/supergit/logo.png
  4. 2
      apps/servers/octopus/supergit/src/repo.rs

@ -1,14 +1,14 @@
[package]
name = "supergit"
description = "A strongly typed, read-only representation of a git repository"
version = "0.2.0"
version = "0.2.1"
authors = ["Katharina Fey <kookie@spacekookie.de>"]
edition = "2018"
license = "GPL-3.0-or-later"
documentation = "https://docs.rs/supergit"
readme = "README.md"
repository = "https://git.spacekookie.de/kookienomicon/about/apps/servers/octopus/supergit"
[dependencies]
git2 = "0.11"
async-std = { version = "1.0", features = ["unstable"] }
atomptr = "1.0"
atomptr = "1.0"
git2 = "0.11"

@ -1,3 +1,33 @@
# supergit
<div align="center">
<img src="/kookienomicon/plain/apps/servers/octopus/supergit/logo.png" width="256px"/>
<h1>supergit</h1>
</div>
A typed wrapper around libgit2.
Strongly typed git repository explorer This library provides a more
Rustic interface for git repositories, built on the `git2` bindings.
If you want more low-level access to your repository, consider using
that library instead.
supergit aims to make queries into a git repo as typed and easy as
possible. Start by creating a `Repository`, and enumerating or
fetching `Branch`es that you are interested in.
```rust
use supergit::Repository;
let r = Repository::open("/path/to/repo").unwrap();
println!("{:?}", r.branches());
let branch = r.branch("main").unwrap();
let head = branch.head();
println!("{}: {}", head.id(), head.summary().unwrap_or("".into()));
```
## Library structure
The main abstraction layer for a repository is a set of iterators,
over branches, commits, and files in commit trees. Some functions
implemented in `supergit` are quite computationally intensive; they
are marked as such with their runtime cost! It's recommended to
include `supergit::prelude` to get started with development.

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

@ -1,6 +1,6 @@
//! Raw representation wrappers for libgit2
use crate::branch::{Branch, BranchCommit};
use crate::branch::Branch;
use git2::{self, Oid};
use std::{fmt, sync::Arc};

Loading…
Cancel
Save