Skip to content

Commit

Permalink
chore: update READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
jrriehl committed Aug 14, 2023
1 parent 09767bc commit b5bdc32
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 9 deletions.
11 changes: 2 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,8 @@
The **μAgents** (micro-Agents) project is a fast and lightweight framework that makes it easy to build agents for all kinds of decentralised use cases.

## Installation
## Python Library

Install μAgents for Python 3.8, 3.9, 3.10, or 3.11:

```bash
cd python
poetry install
poetry shell
```
Go to the [`python`](https://github.com/fetchai/uAgents/tree/main/python) folder for details on the Python uAgents library.

## Documentation

Expand Down Expand Up @@ -39,4 +33,3 @@ We use [GitHub Issues](https://github.com/fetchai/uAgents/issues) for tracking r
## License

The μAgents project is licensed under [Apache License 2.0](https://github.com/fetchai/uAgents/blob/main/LICENSE).

22 changes: 22 additions & 0 deletions python/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## Installation (Python)

Install μAgents for Python 3.8, 3.9, 3.10, or 3.11:

```bash
poetry install
poetry shell
```

## Documentation

Build and run the docs locally with:

```bash
mkdocs serve
```

Or go to the official docs site: https://docs.fetch.ai/uAgents.

## Examples

The [`examples`](https://github.com/fetchai/uAgents/tree/main/python/examples) folder contains several examples of how to create and run various types of agents.

0 comments on commit b5bdc32

Please sign in to comment.