Add generated documentation.

coinbase · Apr 15, 2024 · b435688 · b435688
1 parent 235ba16
commit b435688
Show file tree

Hide file tree

Showing 23 changed files with 6,802 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
 Gemfile.lock
-coinbase_cloud_api_key.json
+coinbase_cloud_api_key.json
+.yardoc
diff --git a/Gemfile b/Gemfile
@@ -10,3 +10,4 @@ gem 'pry'
 gem 'rake'
 gem 'rspec'
 gem 'rubocop', '~> 1.63.1' # Pin to a specific version of RuboCop to ensure consistent linting.
+gem 'yard', '~> 0.9.36' # Pin to a specific version of YARD to ensure consistent documentation generation.
diff --git a/README.md b/README.md
@@ -5,6 +5,11 @@ By calling Coinbase's Platform APIs, the SDK allows you to provision crypto wall
 send crypto into/out of those wallets, track wallet balances, and trade crypto from
 one asset into another.
 
+The SDK currently supports Developer-managed Wallets using Ethereum on Base Sepolia.
+
+**IMPORTANT: The Coinbase SDK is currently under development, and may make backwards-incompatible changes.**
+**Do not use the Coinbase SDK to manage mainnet funds.**
+
 ## Documentation
 
 > TODO
@@ -135,4 +140,12 @@ it, run:
 
 ```bash
 bundle exec bin/repl
+```
+
+### Generating Documentation
+
+To generate documentation from the Ruby comments, run:
+
+```bash
+bundle exec yardoc --output-dir ./docs
 ```