update reaadme

This commit is contained in:
Stan Zubarev
2024-10-31 20:49:13 -04:00
parent 25b742db1f
commit f19263d309
+7 -3
View File
@@ -24,10 +24,12 @@ To specify a specific provider or model, you can use the `llm_provider` and `llm
- [**Ollama**](https://ollama.com)
- [**OpenAI's GPT**](https://openai.com/gpt)
- [**xAI's Grok**](https://x.ai/)
- [**Amazon Bedrock**](https://aws.amazon.com/bedrock/)
If you want to see Simplemind support, additional providers or models, please send a pull request!
## Why SimpleMind?
- **Intuitive**: Built with Pythonic simplicity and readability in mind.
- **For Humans**: Emphasizes a human-friendly interface, just like `requests` for HTTP.
- **Open Source**: Simplemind is open source, and contributions are always welcome!
@@ -56,7 +58,6 @@ Next, import Simplemind and start using it:
import simplemind as sm
```
## Examples
Here are some examples of how to use Simplemind:
@@ -163,6 +164,7 @@ conversation.add_message(
text="Please write a poem about the moon",
)
```
```pycon
>>> conversation.send()
In the vast expanse where stars do play,
@@ -200,9 +202,10 @@ Simple, yet effective.
Please see the [examples](examples) directory for executable examples.
-------------------
---
## Contributing
We welcome contributions of all kinds. Feel free to open issues for bug reports or feature requests, and submit pull requests to make SimpleMind even better.
To get started:
@@ -213,8 +216,9 @@ To get started:
4. Submit a pull request.
## License
Simplemind is licensed under the Apache 2.0 License.
## Acknowledgements
Simplemind is inspired by the philosophy of "code for humans" and aims to make working with AI models accessible to all. Special thanks to the open-source community for their contributions and inspiration.
Simplemind is inspired by the philosophy of "code for humans" and aims to make working with AI models accessible to all. Special thanks to the open-source community for their contributions and inspiration.