Library description

Author: emptybutton

README.md

@@ -1,2 +1,41 @@
-# Named-annotations
-Library for convenient generation of annotations for your code
+## Pyannotating
+Allows you to create similar annotations without copying them all the time.<br>
+It is advisable to place annotations created using this library in annotations.py file.
+
+### Installation
+`pip install Pyannotating`
+
+### Examples
+Creating a factory of your annotations
+```python
+from pyannotating import CustomAnnotationFactory, input_annotation
+from typing import Callable
+
+handler_of = CustomAnnotationFactory(Callable, [[input_annotation], any])
+```
+Now you can create an annotation by this factory
+```python
+handler_of[int | float]
+```
+
+What is equivalent
+```python
+Callable[[int | float], any]
+```
+
+Also you can use Union with input_annotation
+```python
+summator_of = CustomAnnotationFactory(Callable, [[input_annotation | str, input_annotation | int], str | int])
+summator_of[SomeCustomNumber]
+```
+
+What results in
+```python
+Callable[[SomeCustomNumber | str, SomeCustomNumber | int], str | int]
+```
+
+Ultimately you can annotate by the resulting annotations
+```python
+def some_operation_by(main: handler_of[int | float], *middleware: summator_of[SomeCustomNumber]) -> handler_of[int | float]:
+    ...
+```