Skip to content

Commit

Permalink
Release v0.0.1
Browse files Browse the repository at this point in the history
We have to do this at some point right?
  • Loading branch information
boreq committed Mar 2, 2023
1 parent c6e75ef commit a5dc65c
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 8 deletions.
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Changelog

## [Unreleased]

## [0.0.1]

### Added

- This CHANGELOG file.

[unreleased]: https://github.com/planetary-social/scuttlego/compare/v0.0.1...HEAD
[0.0.1]: https://github.com/planetary-social/scuttlego/releases/tag/v0.0.1
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,10 +104,18 @@ your changes.
When naming long-lived feature branches please follow the pattern `feature/...`.
This enables CI for that branch.

### Changelog

We try to keep a changelog which documents all notable changes. The format is
based on [Keep a Changelog][keep-a-changelog]. It is good to
try to update it when preparing a pull request.



[hexagonal-architecture]: https://en.wikipedia.org/wiki/Hexagonal_architecture_(software)

[commit-message]: https://cbea.ms/git-commit/
[keep-a-changelog]: https://keepachangelog.com/en/1.0.0/

[effective-go]: http://golang.org/doc/effective_go.html
[code-review-comments]: https://github.com/golang/go/wiki/CodeReviewComments
Expand Down
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@

A Go implementation of the [Secure Scuttlebutt][ssb] protocol. This
implementation was designed to be used by the [Planetary][planetary] client and
attempts to be efficient, stable and keep a relatively low memory footprint.

**Work in progress. The exposed interfaces and format of the persisted data may
change.**
attempts to be efficient, stable and keep a relatively low memory footprint. As
scuttlego is under active development the exposed interfaces may undergo some
changes as its API stabilizes.

## Features

Expand All @@ -19,17 +18,15 @@ change.**
- Replication scheduler (prioritise closer feeds, avoid replicating the same
messages simultaneously from various peers etc.)
- Replicating and creating blobs
- Pushing blobs
- Tunneling via rooms
- Some commands and queries for managing room aliases

### Planned in the near future
### Planned

- Connection manager (dynamic discovery of pubs from feeds)
- Handling blob wants received from remote peers
- Cleaning up old blobs and messages

### Planned

- Private messages
- Private groups
- Support for other feed formats
Expand Down

0 comments on commit a5dc65c

Please sign in to comment.