Skip to content

docs: minor updates to README files. #36

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

Merged
sscovil merged 2 commits into from
Sep 12, 2025
Merged

docs: minor updates to README files. #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d2a1601
docs: update overview & purpose sections
sscovil Sep 12, 2025
dd1ce30
docs: add troubleshooting tips for general transaction failures
sscovil Sep 12, 2025
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@

## Overview

EVMAuth is an **authorization state management system** for software systems, service providers, and AI agents.
EVMAuth is an **authorization state management system** for APIs, MCP servers, and AI agents.

### Purpose

EVMAuth was created to provide a simple, standardized way to manage persistent authorization without the overhead of developing and maintaining auth servers and databases.
EVMAuth was created to provide a simple, standardized way to manage persistent authorization without the overhead of developing and maintaining auth servers, databases, subscription management services, and payment systems.

### Use Cases

Expand Down
2 changes: 2 additions & 0 deletions script/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,8 @@ Save these addresses for contract interaction and future upgrades.

**Compilation errors**: Run `forge fmt && forge clean && forge build` to check for issues before deployment.

**Transaction failures**: Make sure your environment variables are set correctly and your account has sufficient funds.

[Cast Command Cheat Sheet]: https://github.com/evmauth/evmauth-core/blob/main/CAST_COMMANDS.md
[ERC-1155]: https://eips.ethereum.org/EIPS/eip-1155
[ERC-6909]: https://eips.ethereum.org/EIPS/eip-6909