Skip to content

Fix: Correct typos and improve clarity in README.md #925

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.

Sign up for GitHub

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

Open
thorizerftw wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix: Correct typos and improve clarity in README.md #925

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ Streamline the **Verifiable Credentials issuance** process with the user-friendl
- [License](#license)

## Quick Start Installation
> [!NOTE]
> The provided installation guide is **non-production** ready. For production deployments please refer to [Standalone Mode Guide](https://docs.privado.id/docs/issuer/setup-issuer-core).
> [!NOTE:]
> The provided installation guide is **not production-ready**. For production deployments please refer to [Standalone Mode Guide](https://docs.privado.id/docs/issuer/setup-issuer-core).
>
> There is no compatibility with Windows environments at this time. While using WSL should be ok, it's not officially supported.
> There is currently compatibility no with Windows environments. While using WSL should be ok, it's not officially supported.
>
> **After changing the configuration, you must restart the issuer node docker containers.**

Expand All @@ -58,7 +58,7 @@ Streamline the **Verifiable Credentials issuance** process with the user-friendl
- [Infura](https://www.infura.io/)

### Run Issuer Node API and UI (docker compose with images from privadoid registry)
To run the issuer node (API and UI) quickly and without too many customizations follow the following steps:
To quickly run the issuer node (API and UI) with minimal customizations, follow these steps:

1. Copy the config sample files:
```shell
Expand Down