Skip to content

Commit

Permalink
fixed linting for readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
krishnaglodha committed Dec 1, 2024
1 parent 5012996 commit c085632
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,11 @@ A modern, powerful GeoServer REST API client influenced by HTTPX, offering Sync,
```bash
pip install geoserverx
```

## Quick Start

### Synchronous Usage

```python
from geoserverx._sync.gsx import SyncGeoServerX

Expand All @@ -49,6 +52,7 @@ print(workspaces.workspaces.workspace[0].name) # Print first workspace name
```

### Asynchronous Usage

```python
from geoserverx._async.gsx import AsyncGeoServerX
import asyncio
Expand All @@ -62,6 +66,7 @@ asyncio.run(main())
```

### CLI Usage

```bash
# Get help
geoserverx --help
Expand All @@ -74,29 +79,36 @@ geoserverx workspaces create --name my_workspace
```

## Documentation

Detailed documentation is available through [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)

## Development Setup

Install Poetry (dependency management tool):

```bash
curl -sSL https://install.python-poetry.org | python3 -
```

```bash
# Clone the repository:
git clone https://github.com/geobeyond/geoserverx.git
cd geoserverx
```

```bash
# Install dependencies:
poetry install
```

```bash

# Activate virtual environment:
poetry shell
```

## Contributing

We welcome contributions! Here's how you can help:

- Check for open issues or create a new one to discuss new features or bugs.
Expand All @@ -114,12 +126,15 @@ We welcome contributions! Here's how you can help:
- Update documentation as needed

## Bug Reports and Feature Requests

Please use the GitHub issue tracker to report bugs or request features.

## License

This project is licensed under the MIT License - see the LICENSE file for details.

## Acknowledgments

- HTTPX for inspiration
- GeoServer community
- All contributors who have helped shape this project
- All contributors who have helped shape this project

0 comments on commit c085632

Please sign in to comment.