Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Hellblazer committed Aug 10, 2024
1 parent df429aa commit af88574
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Apollo Delphinius project is an experimental multi-tenant, distributed system platform. Apollo provides a secure
communications overlay using Fireflies. The consensus layer is supplied by an asynchronous bft consensus protocol. The
sql state interface is via a JDBC connection over replicated SQL state machines, supported by checkpointed CHOAM linear
sql state interface is via a JDBC connection over replicated SQL state machines, supported by check pointed CHOAM linear
logs. Decentralized identity and key management are provided as a foundational service and integrated into the MTLS grpc
communication.

Expand Down Expand Up @@ -48,7 +48,7 @@ Apollo requires JDK 22+ and [Maven](https://maven.apache.org/) 3.9.3 and above

### Install Maven

The build includes _mvnw_, and thus there is not need to install Maven. Simply use ./mvnw for all your Maven invocation
The build includes _mvnw_, and thus there is no need to install Maven. Simply use ./mvnw for all your Maven invocation
needs.

See [Installing Apache Maven](https://maven.apache.org/install.html) if you prefer to install Maven.
Expand Down Expand Up @@ -96,8 +96,8 @@ profiles that are activated for the platform the build is running on.

## Modules

Apollo is modularized largely for the purpose of subsystem isolation and reuse. Each module is a Maven module
under the source root and contains a README.md documenting (such as it is at the moment, lol) the module.
Apollo is modularized largely for subsystem isolation and reuse. Each module is a Maven module
under the source root and contains a README.md documenting the module.

* [CHOAM](choam/README.md) - Committee maintenance of replicated state machines
* [Delphinius](delphinius/README.md) - Bare bones Google Zanzibar clone
Expand Down Expand Up @@ -242,7 +242,7 @@ Myself, I find that I have to first select the top level Apollo.app module, and
sources** (or the equivalent in your IDE). This *should* generate all the sources required for every submodule, so...

Feel free to generate issues and such, and I will look into it as I do want this to be flawless and a good experience. I
know that's impossible, but it undoubtedly can be made better, and PRs are, of course, a thing.
know that's impossible, but it undoubtedly can be made better, and PRs are a thing.

Note that also, for inexplicable reasons, Eclipse Maven will determine it needs to invalidate the _grpc_ generated code
and will thus need to be regenerated. I'm trying to figure out the heck is going on, but when this happens, please
Expand Down Expand Up @@ -273,6 +273,5 @@ Apollo is using Aleph-BFT for consensus, in the form of the Ethereal module. CHO
SQL replicated state machine now uses CHOAM for its linear log and transaction model.

Multi-tenant shards are in place and apparently working. This integrates Stereotomy and Delphinius using CHOAM in
a Domain model. E2E testinsg of the ReBAC Delphinius service is finished and working. Full integration of ProcessDomains
using
Fireflies discovery works from bootstrap to Delphinius Oracle ReBAC E2E testing.
a Domain model. E2E testing of the ReBAC Delphinius service is finished and working. Full integration of ProcessDomains
using Fireflie and discovery - bootstrap to Delphinius Oracle ReBAC E2E testing.

0 comments on commit af88574

Please sign in to comment.