diff --git a/README.md b/README.md index e06f85b..c395ba6 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,32 @@ -# FindMy.py +
+ FindMy.py Logo +

FindMy.py

+
-[![](https://img.shields.io/pypi/v/FindMy)](https://pypi.org/project/FindMy/) -[![](https://img.shields.io/pypi/dm/FindMy)](#) -[![](https://img.shields.io/github/license/malmeloo/FindMy.py)](LICENSE.md) -[![](https://img.shields.io/pypi/pyversions/FindMy)](#) +
-
- Star History - -
+ _Query Apple's FindMy network with Python!_ -The all-in-one library that provides everything you need -to query Apple's FindMy network! +
+ + Docs + + | + + Examples + + | + + PyPI + + | + + Issue Tracker + +
+
+## ๐Ÿš€ Overview The current "Find My-scene" is quite fragmented, with code being all over the place across multiple repositories, written by [several authors](#Credits). This project aims to @@ -27,7 +41,7 @@ application wishing to integrate with the Find My network. > You are encouraged to report any issues you can find on the > [issue tracker](https://github.com/malmeloo/FindMy.py/issues/)! -### Features +## ๐Ÿงช Features - [x] Cross-platform: no Mac needed - [x] Fetch and decrypt location reports @@ -41,12 +55,7 @@ application wishing to integrate with the Find My network. - [x] Import or create your own accessory keys - [x] Both async and sync APIs -### Roadmap - -- [ ] Local anisette generation (without server) - - More information: [#2](https://github.com/malmeloo/FindMy.py/issues/2) - -## Installation +## ๐Ÿ“ฅ Installation The package can be installed from [PyPi](https://pypi.org/project/findmy/): @@ -58,7 +67,7 @@ For usage examples, see the [examples](examples) directory. We are also building out a CLI. Try `python -m findmy` to see the current state of it. Documentation can be found [here](http://docs.mikealmel.ooo/FindMy.py/). -## Contributing +## ๐Ÿค Contributing Want to contribute code? That's great! For new features, please open an [issue](https://github.com/malmeloo/FindMy.py/issues) first so we can discuss. @@ -76,7 +85,7 @@ pre-commit install After following the above steps, your code will be linted and formatted automatically before committing it. -## Derivative projects +## ๐Ÿง  Derivative projects There are several other cool projects based on this library! Some of them have been listed below, make sure to check them out as well. @@ -87,7 +96,7 @@ There are several other cool projects based on this library! Some of them have b * [OpenTagViewer](https://github.com/parawanderer/OpenTagViewer) - Android App to locate your AirTags. * [Find My Dad](https://github.com/NickCrews/findmydad) - Geofencing application for AirTags using Google Sheets and SMS. -## Credits +## ๐Ÿ… Credits While I designed the library, the vast majority of actual functionality is made possible by the following wonderful people and organizations: