diff --git a/README.md b/README.md index 5fa891e16f..6c919142cd 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,31 @@ -

Atala PRISM v2 - The modern SSI ecosystem.

- atala-prism-logo -
- is an ecosystem and development platform for Self-Sovereign Identity applications - -
-

-

- - www.atalaprism.io + + atala-prism-logo
-

-

- Contributing Guidelines + Unit tests + End-to-end tests + Performance tests +
+ Modern ecosystem and development platform for Self-Sovereign Identity applications +


-## Documentation - - - -* [Interdependencies](./Interdependencies.md) -* [repositories and relationships](./RepositoriesRrelationships.md) +## User documentation -## Running a single instance locally +* [Documentation portal](https://docs.atalaprism.io/) +* [Handbook](https://handbook.atalaprism.io/) -Instructions for running the `building-block` stack locally can be found here: [Running locally](infrastructure/local/README.md) +## Developer documentation -## Running multiple instances locally - -Instructions for running multiple instances of the `building-block` stack locally can be found here: [Running multiple locally](infrastructure/multi/README.md) - -## Running a instanve locally from sbt (single project) - - -Run sbt from the root of the repository -- if you want to run the `prism-agent` call the comment `sbt> prismAgentServer/runMain io.iohk.atala.agent.server.AgentApp` - -## Developing - -Instructions for running the `building-block` stack for development purposes can be found here: [Developing locally](infrastructure/local/README.md) - - -## Contributing - -Read through our [contributing guidelines][contributing] to learn about our submission process, coding rules and more. +* [Contributing Guidelines](CONTRIBUTING.md) +* [Interdependencies](./docs/general/Interdependencies.md) +* [Repositories & relationships](./docs/general/repositories_relationships.md) +* [Code linting](./docs/guides/linting.md) +* [Signing commits](./docs/guides/signing_commits.md) +* [Running agent locally](./infrastructure/local/README.md)
**Love Atala PRISM? Give our repo a star :star: :arrow_up:.** - -[openapi]: docs/README.md -[contributing]: CONTRIBUTING.md diff --git a/Interdependencies.md b/docs/general/interdependencies.md similarity index 100% rename from Interdependencies.md rename to docs/general/interdependencies.md diff --git a/RepositoriesRrelationships.md b/docs/general/repositories_relationships.md similarity index 100% rename from RepositoriesRrelationships.md rename to docs/general/repositories_relationships.md diff --git a/docs/images/logos/atala-prism-logo.png b/docs/images/logos/atala-prism-logo.png new file mode 100644 index 0000000000..2c0c4b960c Binary files /dev/null and b/docs/images/logos/atala-prism-logo.png differ diff --git a/docs/images/logos/atala-prism-logo.svg b/docs/images/logos/atala-prism-logo.svg index 52e4aece87..6cd71c6bbd 100644 --- a/docs/images/logos/atala-prism-logo.svg +++ b/docs/images/logos/atala-prism-logo.svg @@ -1,26 +1,87 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file