Merge pull request #1 from Helyux/dev

Release 0.4.0

Author: Helyux

README.md

@@ -5,7 +5,7 @@
 [![Forks][forks-shield]][forks-url]
 [![Stargazers][stars-shield]][stars-url]
 [![Issues][issues-shield]][issues-url]
-[![MIT License][license-shield]][license-url]
+[![GPLv3 License][license-shield]][license-url]
 [![Xing][xing-shield]][xing-url]
 </div>
 
@@ -21,6 +21,45 @@
 pip install cs2pattern
 ```
 
+## Usage
+
+### Quick start
+
+```python
+from cs2pattern import check_rare
+
+is_rare, details = check_rare("★ Karambit | Case Hardened (Factory New)", 941)
+if is_rare:
+    pattern_name, index = details
+    print(f"Rare pattern: {pattern_name} (index {index})")
+else:
+    print("Nothing special here.")
+```
+
+### Modular helpers
+
+When you already know the skin family you care about, import the helper functions:
+
+```python
+from cs2pattern import gem_black
+
+patterns, ordered = gem_black("skeleton knife")
+print("Patterns:", patterns)
+print("Ordered:", ordered)
+```
+
+### Raw catalog access
+
+Helper names match the pattern groups inside `pattern.json`, so you can discover what is available by calling `get_pattern_dict()` and inspecting the keys.
+
+```python
+from cs2pattern import get_pattern_dict
+
+catalog = get_pattern_dict()
+scorched_ursus = catalog["scorched"]["ursus knife"][0]
+print(scorched_ursus["pattern"])
+```
+
 ## Contributing
 Contributions are welcome! Open an issue or submit a pull request.
 
@@ -37,7 +76,7 @@ GPLv3 License. See the LICENSE file for details.
 [stars-url]: https://github.com/Helyux/cs2pattern/stargazers
 [issues-shield]: https://img.shields.io/github/issues/Helyux/cs2pattern.svg?style=for-the-badge
 [issues-url]: https://github.com/Helyux/cs2pattern/issues
-[license-shield]: https://img.shields.io/github/license/Helyux/cs2pattern.svg?style=for-the-badge
+[license-shield]: https://img.shields.io/badge/License-GPLv3-blue.svg?style=for-the-badge
 [license-url]: https://github.com/Helyux/cs2pattern/blob/master/LICENSE
 [xing-shield]: https://img.shields.io/static/v1?style=for-the-badge&message=Xing&color=006567&logo=Xing&logoColor=FFFFFF&label
 [xing-url]: https://www.xing.com/profile/Lukas_Mahler10

cs2pattern/__init__.py

@@ -1,36 +1,37 @@
-__author__ = "Lukas Mahler"
-__version__ = "0.0.0"
-__date__ = "28.03.2025"
-__email__ = "m@hler.eu"
-__status__ = "Development"
-
-
-from cs2pattern.check import check_rare, get_pattern_dict
-from cs2pattern.modular import *
-
-__all__ = [
-    'check_rare',
-    'get_pattern_dict',
-
-    'abyss',
+__author__ = "Lukas Mahler"
+__version__ = "0.4.0"
+__date__ = "15.10.2025"
+__email__ = "m@hler.eu"
+__status__ = "Development"
+
+from cs2pattern.check import check_rare, get_pattern_dict
+from cs2pattern.modular import *
+
+__all__ = [
+    'check_rare',
+    'get_pattern_dict',
+    'abyss',
     'berries',
     'blaze',
     'fire_and_ice',
+    'gem_black',
     'gem_blue',
     'gem_diamond',
     'gem_gold',
     'gem_green',
     'gem_pink',
-    'gem_purple',
-    'gem_white',
-    'grinder',
-    'hive',
-    'moonrise',
-    'paw',
+    'gem_purple',
+    'gem_white',
+    'grinder',
+    'hive_blue',
+    'hive_orange',
+    'moonrise',
+    'nocts',
+    'paw',
     'phoenix',
-    'pussy'
+    'pussy',
 ]
-
-
-if __name__ == '__main__':
-    exit(1)
+
+
+if __name__ == '__main__':
+    exit(1)