Commit 1c68bee
authored
Update README and env examples (#72)
* chore: Update .env.template with new API keys and tool configurations
- Added new environment variables for LLM provider and model, Mapbox access token, and various API keys for Messari, Thirdweb, CoinMarketCap, Air Quality, and Depin Ninja.
- Updated tool selection instructions to clarify usage of specialty tools.
- Enhanced documentation within the .env.template for better guidance on API key usage and tool availability.
* docs: Update README.md for improved clarity and accuracy
- Enhanced the LLM Integration section to specify supported LLM providers, including OpenAI, Anthropic, and DeepSeek.
- Updated the architecture diagram to reflect the new ElizoOS Stack and Quicksilver System structure.
- Clarified the configuration structure and instance management instructions for better user guidance.
- Improved the available tools section by adding new tools and their parameters, ensuring comprehensive documentation.
* docs: Update README.md to enhance API reference and clarity
- Added API reference section detailing REST endpoints for interacting with the Sentient AI system, including base URL, authentication, and endpoint descriptions.
- Improved clarity in the available tools section by standardizing quotes and ensuring consistent formatting throughout the document.
- Expanded on the integration of DePIN network and custom tools, inviting contributors to enhance the project further.
* docs: Add Table of Contents to README.md for improved navigation
- Introduced a comprehensive Table of Contents section to enhance user navigation through the README.
- Organized links to key sections including Features, Architecture, Getting Started, API Reference, and Contributing, ensuring better accessibility to important information.
* docs: Update README.md architecture diagram for clarity
- Refined the architecture diagram by simplifying node labels for better readability.
- Removed unnecessary emojis and standardized names to enhance clarity and maintainability.
* docs: Revise README.md for improved structure and clarity
- Updated the Table of Contents for better navigation, reorganizing sections for logical flow.
- Enhanced the API Reference section with detailed endpoint descriptions and examples.
- Added new sections for Integrations and Future Development to invite community contributions and outline potential growth areas.
- Improved formatting and consistency throughout the document to enhance readability and maintainability.
* docs: Simplify response structure in README.md
- Updated the API response example to clarify the format of tool-specific response data.
- Removed unnecessary comments to enhance readability and maintainability of the documentation.1 parent ed61bc7 commit 1c68bee
2 files changed
+270
-135
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
1 | 4 | | |
2 | 5 | | |
3 | 6 | | |
4 | 7 | | |
5 | | - | |
6 | | - | |
7 | | - | |
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
11 | | - | |
12 | | - | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
13 | 14 | | |
14 | 15 | | |
15 | 16 | | |
16 | 17 | | |
17 | 18 | | |
18 | 19 | | |
19 | 20 | | |
20 | | - | |
21 | | - | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
22 | 26 | | |
23 | 27 | | |
24 | 28 | | |
| |||
30 | 34 | | |
31 | 35 | | |
32 | 36 | | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
33 | 53 | | |
34 | | - | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
0 commit comments