docs: improve README formatting and add development instructions

- Use consistent formatting for emphasis (_text_ instead of *text*)
- Add instructions for initializing submodules
- Add instructions for running GitHub Actions locally
- Fix whitespace and formatting throughout file

🤖 Generated with Claude Code
Co-Authored-By: Claude <[email protected]>

Author: samspycher

README.md

@@ -2,7 +2,7 @@
 
 This repository contains a Java Client and a [JCA provider](https://docs.oracle.com/javase/8/docs/technotes/guides/security/crypto/CryptoSpec.html) for Parsec. The client exposes the [PSA Crypto API](https://github.com/ARMmbed/mbed-crypto/blob/psa-crypto-api/docs/PSA_Cryptography_API_Specification.pdf) to Java Applications and the JCA Provider allows existing applications that employ JCA to switch to Parsec.
 
-*Note*: this client is at an early stage of development and not yet ready for production use. We welcome contributions!
+_Note_: this client is at an early stage of development and not yet ready for production use. We welcome contributions!
 
 ## In this repository
 
@@ -12,16 +12,31 @@ The repository contains the following packages:
 - parsec-jca-java: JCA Provider
 - parsec-interface-java: Private wrapper for protobuf classes and socket communication
 - parsec-protobuf-java: Java Protobuf classes (generated)
-- parsec-testcontainers: Collection of Docker test containers for development & testing 
+- parsec-testcontainers: Collection of Docker test containers for development & testing
 
 # How to use this library
+
 TODO
 
 # How to develop the Parsec Java Client
-TODO
+
+Check out this repo's submodules:
+
+```sh
+git submodule update --init --recursive
+```
+
+You can use `act` to run the github action locally. On OSX, you need to set the container architecture, and for testcontainers to work, you may need to set the env var `TESTCONTAINERS_HOST_OVERRIDE`.
+
+Example CLI input:
+
+```sh
+act --container-architecture linux/amd64 --env TESTCONTAINERS_HOST_OVERRIDE=`ipconfig getifaddr en0`
+```
 
 # Example Implementations
-There are a number of example implementations of both the basic java client and JCA provider along with a demo (separate repository) 
+
+There are a number of example implementations of both the basic java client and JCA provider along with a demo (separate repository)
 Both the tests and workshop demo cover the basic functionality of the current implementation:
 
 - Parsec JCA Tests [**Link**](/parsec-jca-test)
@@ -34,10 +49,8 @@ The software is provided under Apache-2.0. Contributions to this project are acc
 
 ## Contributing
 
-We welcome contributing, both in the use of this client library and programming,extending of this library code base. 
+We welcome contributing, both in the use of this client library and programming,extending of this library code base.
 Please check the [**Contribution Guidelines**](https://parallaxsecond.github.io/parsec-book/contributing/index.html)
 to know more about the contribution process.
 
-*Copyright 2021 Contributors to the Parsec project.*
-
-
+_Copyright 2021 Contributors to the Parsec project._