mirror of
https://seed.radicle.dev/rad:z6cFWeWpnZNHh9rUW8phgA3b5yGt.git
synced 2026-11-16 00:10:35 +08:00
29 lines
919 B
Markdown
29 lines
919 B
Markdown
# radicle-surf
|
|
|
|
A code surfing library for Git repositories 🏄♀️🏄♂️
|
|
|
|
Welcome to `radicle-surf`!
|
|
|
|
`radicle-surf` is a library to describe a Git repository as a file system. It
|
|
aims to provide an easy-to-use API to browse a repository via the concept of
|
|
files and directories for any given revision. It also allows the user to diff
|
|
any two different revisions.
|
|
|
|
One of the use cases would be to create a web GUI for interacting with a Git
|
|
repository (thinking GitHub, GitLab or similar systems).
|
|
|
|
## Contributing
|
|
|
|
To get started on contributing you can check out our [developing guide](../DEVELOPMENT.md), and also
|
|
our [LICENSE](../LICENSE) file.
|
|
|
|
## The Community
|
|
|
|
Join our community disccussions at [radicle.community](https://radicle.community)!
|
|
|
|
|
|
# Example
|
|
|
|
To a taste for the capabilities of `radicle-surf` we provide an example below, but we also
|
|
keep our documentation and doc-tests up to date.
|