updated README

westandskif · Mar 3, 2024 · 7c701bc · 7c701bc
1 parent a1d9898
commit 7c701bc
Showing 1 changed file with 30 additions and 27 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -3,8 +3,11 @@
 `synclane` simplifies development of systems with Python backend and TypeScript
 frontend.
 
+You simply define framework-agnostic RPC object with typing-based validation
+and use automatically generated TypeScript functions to consume it.
+
 [![License](https://img.shields.io/github/license/westandskif/synclane.svg)](https://github.com/westandskif/synclane/blob/master/LICENSE.txt)
-[![codecov](https://codecov.io/gh/westandskif/synclane/branch/master/graph/badge.svg)]( https://codecov.io/gh/westandskif/synclane)
+[![codecov](https://codecov.io/gh/westandskif/synclane/branch/master/graph/badge.svg)](https://codecov.io/gh/westandskif/synclane)
 [![Tests status](https://github.com/westandskif/synclane/workflows/tests/badge.svg)](https://github.com/westandskif/synclane/actions/workflows/pytest.yml)
 [![Docs status](https://readthedocs.org/projects/synclane/badge/?version=latest)](https://synclane.readthedocs.io/en/latest/?badge=latest)
 [![PyPI](https://badge.fury.io/py/synclane.svg)](https://pypi.org/project/synclane/)
@@ -23,6 +26,32 @@ frontend.
      [fetch options](https://developer.mozilla.org/en-US/docs/Web/API/fetch)
      as needed
 
+## Installation
+
+```bash
+pip install synclane
+```
+
+[pydantic](https://github.com/pydantic/pydantic) is the only dependency.
+
+## Example
+
+/// tab | main.py
+
+```python
+{!../tests/int_tst_fastapi/main.py!}
+```
+
+///
+
+/// tab | client.test.ts
+
+```typescript
+{!../tests/int_tst_fastapi/tests/client.test.ts!}
+```
+
+///
+
 ## Benefits
 
 #### Automated typescript client generation
@@ -60,29 +89,3 @@ API endpoint url.
 
 If your procedure in/out types include enums, they will become available in the
 typescript client.
-
-## Installation
-
-```bash
-pip install synclane
-```
-
-[pydantic](https://github.com/pydantic/pydantic) is the only dependency.
-
-## Example
-
-/// tab | main.py
-
-```python
-{!../tests/int_tst_fastapi/main.py!}
-```
-
-///
-
-/// tab | client.test.ts
-
-```typescript
-{!../tests/int_tst_fastapi/tests/client.test.ts!}
-```
-
-///