Skip to content

Commit

Permalink
small readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
mvexel committed Jan 27, 2025
1 parent cada06f commit 01fe848
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@

A read-only interface to OpenStreetMap change APIs and files. See also [pyosm](https://github.com/iandees/pyosm) which can do similar things.

## Documentation

📚 Comprehensive documentation is available at [mvexel.github.io/osmdiff](https://mvexel.github.io/osmdiff/)

## Python Version Support

This module has been tested with Python 3.8 - 3.12. Use at your own risk with other versions.

## Installing
Expand All @@ -12,6 +18,8 @@ This module has been tested with Python 3.8 - 3.12. Use at your own risk with ot

## Usage

See the [documentation](https://mvexel.github.io/osmdiff/) for more details.

### Reading

Retrieve the latest replication diff from the OSM API:
Expand Down Expand Up @@ -136,6 +144,16 @@ change = OSMChange(
)
```

## Community

Join the conversation and get help:

- [GitHub Discussions](https://github.com/mvexel/osmdiff/discussions) - For questions, ideas, and general discussion
- [OpenStreetMap Community Forum](https://community.openstreetmap.org/) - For broader OSM-related discussions
- [OSM Slack](https://osmus.slack.com/) - Join the #dev channel

Please be respectful and follow the [OpenStreetMap Code of Conduct](https://wiki.openstreetmap.org/wiki/Code_of_conduct) in all community interactions.

## Contributing

I welcome your contributions in code, documentation and suggestions for enhancements.
Expand Down

0 comments on commit 01fe848

Please sign in to comment.