Skip to content

Commit

Permalink
docs: clean up README and CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
TheButlah committed Sep 28, 2024
1 parent a70d335 commit 7a567c4
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 19 deletions.
8 changes: 0 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,6 @@ This document outlines some helpful guidelines if you wish to contribute to the
- We enforce that `cargo clippy` passes in CI. Be sure to fix any warnings.
- We also enforce that tests pass.

## Project Structure

Code broadly useful to the ecosystem should go under the `crates/` directory.
Application-specific code should go under the `apps/` directory. It is advisable to
treat your code as application specific initially, and later migrate it to `crates/`
once you are more confident about how to use it outside your application specific
context.

## Style Guide

General guidance:
Expand Down
19 changes: 8 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
# NexusSocial Identity Repo

This serves as a monorepo for a variety of projects. See the `crates` dir for
libraries and `apps` for application-specific crates.

## Apps

- [identity_server](apps/identity_server) - HTTP server for running a did:web node.

## Libraries

- [did-simple](crates/did-simple) - An easy to use crate for working with
Decentralized Identifiers (DIDs).
This serves as a monorepo for projects related to accounts and identity.

In particular, it hosts:
* [did-simple](/did-simple) - A simple pure rust and sans-io crate with minimal
dependencies to work with did:key and did:web urls, signing, and verifying.
did:web
* [identity-server](/identity-server) - A did:web HTTP server that implements a "sign
in with google/meta" approach.

## First Time Setup

Expand Down

0 comments on commit 7a567c4

Please sign in to comment.