Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up the book a little #8

Merged
merged 2 commits into from
Oct 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# Anchor: A Secret Share Validator (SSV) Client in Rust
# Anchor :anchor:
#### Secret Share Validator (SSV) Validator Client

Open source implantation of the Secret Shared Validator (SSV) protocol, written
in Rust and maintained by Sigma Prime.
[![Book Status]][Book Link] [![CI status]][gh-ci]

[![Book Status]][Book Link] [![Chat Badge]][Chat Link]
Anchor is an open source implementation of the Secret Shared Validator (SSV) protocol, written
in Rust and maintained by [Sigma Prime](https://github.com/sigp).

[CI Status]: https://github.com/sigp/anchor/workflows/test-suite/badge.svg
[gh-ci]: https://github.com/sigp/anchor/actions/workflows/test-suite.yml
[Book Status]:https://img.shields.io/badge/user--docs-stable-informational
[Book Link]: https://anchor-book.sigmaprime.io
[stable]: https://github.com/sigp/anchor/tree/stable
Expand All @@ -20,7 +23,7 @@ be used for production until a formal production release has been made.

The [Anchor Book](https://anchor-book.sigmaprime.io) contains information for users and
developers. Instructions for how to compile/build and run this client are all
contained in this book.
contained within this book.

## Branches

Expand Down
4 changes: 2 additions & 2 deletions book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

* [Introduction](./intro.md)
* [FAQs](./faq.md)
* [Protocol Developers](./developers.md)
* [Development Environment](./setup.md)
* [Contributing](./contributing.md)
* [Development Environment](./setup.md)
* [Protocol Developers](./developers.md)
10 changes: 8 additions & 2 deletions book/src/intro.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
# Lighthouse Book
# Anchor Book

_Documentation for Anchor users and developers._

This is the Anchor client.
The Anchor client is an SSV client written in rust. Anchor has been built from the ground up to be
highly performant and secure.

This book aims to provide help and support to users and developers of this client.

> Note: The Anchor client is currently under heavily development and should not be used in a
production setting.

## About this Book

Expand Down