Skip to content

Commit

Permalink
feat(monorepo): unify Storacha Go repositories into a single go-libst…
Browse files Browse the repository at this point in the history
…oracha library

This commit merges the existing Storacha Go repositories (go-capabilities, go-metadata,
go-piece, go-jobqueue, and ipni-publisher) into a single monorepo called go-libstoracha.
The full git histories of each repo are preserved during the migration.

A new top-level README consolidates the prior package-specific READMEs, providing a unified
overview of the library. Each original project is retained as a subpackage in go-libstoracha,
and all existing code references have been updated.
  • Loading branch information
frrist authored and frrist committed Feb 14, 2025
1 parent 41f1c1f commit e92961a
Show file tree
Hide file tree
Showing 50 changed files with 320 additions and 2,996 deletions.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# go-libstoracha
A unified Go library (monorepo) for Storacha functionality. This repository hosts multiple subpackages that address different aspects of Storacha’s ecosystem—from capability definitions to job queuing and more.

## Subpackages
- [capabilities](./capabilities)
- **Description:** UCAN capability definitions for the Storacha ecosystem.
- [metadata](./metadata)
- **Description:** IPNI metadata used by the Storacha Network.
- [jobqueue](./jobqueue)
- **Description:** A reliable and parallelizable job queue.
- [ipnipublisher](./ipnipublisher)
- **Description**: A library to create, sign, and publish adverts to a local IPNI chain, then announce them to other indexers.
- **Usage**: See the [example_test.go](./ipnipublisher/example_test.go) file within this subpackage for a quick start.
- [piece](./piece)
- **Description**: TODO

# Contributing
All are welcome! Storacha is open-source. Please feel empowered to open a pull request or file an issue if you have questions, suggestions, or bug reports.

# License
Dual-licensed under [Apache 2.0 OR MIT](./LICENSE.md). You may choose either license when using or contributing to this project.

8 changes: 1 addition & 7 deletions capabilities/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
# go-capabilities
# capabilities

UCAN capability definitions.

## Usage

```sh
go get github.com/storacha/go-capabilities
```

## Contributing

All welcome! Storacha is open-source. Please feel empowered to open a PR or an issue.
Expand Down
98 changes: 0 additions & 98 deletions capabilities/go.mod

This file was deleted.

Loading

0 comments on commit e92961a

Please sign in to comment.