diff --git a/README.md b/README.md index 9d2815738d..749318d04f 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,24 @@ Integration of the [`ledger`](https://github.com/IntersectMBO/cardano-ledger), [ See the [Contributing guide](CONTRIBUTING.md) for how to contribute to this project. +## Development Setup + +### Using Claude Code + +For developers using [Claude Code](https://claude.ai/code), project-specific configuration can be set up by: + +1. Clone the omni-dev-config repository: + ```bash + git clone https://github.com/input-output-hk/omni-dev-config + ``` + +2. Symlink `CLAUDE.md` from omni-dev-config to this repository: + ```bash + ln -s /path/to/omni-dev-config/CLAUDE.md /path/to/cardano-api/CLAUDE.md + ``` + +This provides Claude Code with project-specific context, coding standards, and best practices. + ## Core maintainers * [Jordan Millar](https://github.com/Jimbo4350) @@ -17,6 +35,12 @@ See the [Contributing guide](CONTRIBUTING.md) for how to contribute to this proj ## Documentation +Package-specific documentation: +- [cardano-api](cardano-api/README.md) - Main library for constructing and submitting transactions +- [cardano-api-gen](cardano-api-gen/README.md) - Test generators and property testing utilities +- [cardano-rpc](cardano-rpc/README.md) - gRPC client and server implementing UTxO RPC protocol +- [cardano-wasm](cardano-wasm/README.md) - WebAssembly compilation support + Development documentation can be found in [Cardano Node Wiki](https://github.com/input-output-hk/cardano-node-wiki/wiki). Haddock documentation is available at: https://cardano-api.cardano.intersectmbo.org/ diff --git a/cardano-api-gen/cardano-api-gen.cabal b/cardano-api-gen/cardano-api-gen.cabal index 5b219e1a79..3f9beac09b 100644 --- a/cardano-api-gen/cardano-api-gen.cabal +++ b/cardano-api-gen/cardano-api-gen.cabal @@ -8,7 +8,7 @@ category: API, Test, -copyright: 2020-2024 Input Output Global Inc (IOG). +copyright: 2020-2025 Input Output Global Inc (IOG). author: IOHK maintainer: operations@iohk.io license: Apache-2.0 diff --git a/cardano-api/cardano-api.cabal b/cardano-api/cardano-api.cabal index 6b0d08b817..99b2d9ff71 100644 --- a/cardano-api/cardano-api.cabal +++ b/cardano-api/cardano-api.cabal @@ -7,7 +7,7 @@ category: Cardano, API, -copyright: 2020-2024 Input Output Global Inc (IOG). +copyright: 2020-2025 Input Output Global Inc (IOG). author: IOHK maintainer: operations@iohk.io license: Apache-2.0 diff --git a/cardano-api/src/Cardano/Api.hs b/cardano-api/src/Cardano/Api.hs index 5696d1ab85..2b9d36543d 100644 --- a/cardano-api/src/Cardano/Api.hs +++ b/cardano-api/src/Cardano/Api.hs @@ -73,6 +73,7 @@ module Cardano.Api , module Cardano.Api.Monad.Error , module Cardano.Api.Pretty , module Cardano.Api.IO + , module Cardano.Api.HasTypeProxy ) where