Coverage for main. Documentation for poetry. (#17)

DEVELOPMENT.md

@@ -2,6 +2,25 @@
 
 ## Configure the package for local development
 
+### New way (poetry)
+
+Install needed packages and GPTSwarm into the current environment.
+```bash
+poetry install
+```
+
+Install needed and uninstall not listed packages:
+```bash
+poetry install --sync
+```
+
+If dev packages not installed for some reason:
+```bash
+poetry install --with=dev --sync
+```
+
+### Old way (setuptools)
+
 The following command installs the `gptswarm` package as a symbolic link to the current github repo clone. All edits to the repo will be immediately reflected in the "installed" package.
 ```bash
 pip insall -e .
@@ -39,6 +58,12 @@ Test specific function:
 pytest -s test/swarm/graph/test_swarm.py -k 'test_raises'
 ```
 
+Running any of the above commands with poetry will auto activate the virtual environment:
+
+```bash
+poetry run pytest -m mock_llm
+```
+
 ## Run code coverage
 
 ```bash

README.md

@@ -4,7 +4,7 @@
 [![Issues](https://img.shields.io/github/issues/metauto-ai/GPTSwarm?color=00afaa)](https://github.com/metauto-ai/gptswarm/issues)
 [![Twitter Follow](https://img.shields.io/twitter/follow/AI_KAUST?style=social)](https://twitter.com/AI_KAUST)
 [![Wechat](https://img.shields.io/badge/Wechat-7BB32E?logo=wechat&logoColor=white)](https://metauto.ai/images/wechat.jpeg)
-[![Coverage Status](https://coveralls.io/repos/github/metauto-ai/GPTSwarm/badge.svg?branch=coveralls)](https://coveralls.io/github/metauto-ai/GPTSwarm?branch=coveralls)
+[![Coverage Status](https://coveralls.io/repos/github/metauto-ai/GPTSwarm/badge.svg?branch=main)](https://coveralls.io/github/metauto-ai/GPTSwarm?branch=main)
 
 <p align="left">
 <a href=""><img src="swarm/utils/assets/logo.png" alt="GPTSwarm" width="430px"></a>
@@ -17,8 +17,7 @@
 
 ## News
 
-✨ March 3, 2024: GPTSwarm support PyPI: ``pip install gptswarm``.
-
+✨ March 3, 2024: GPTSwarm can be installed via pip now: ``pip install gptswarm``
 🚀 Feb 27, 2024: Our academic paper: [Language Agents as Optimizable Graphs](https://arxiv.org/abs/2402.16823) is released.
 
 ## Edge optimization example