diff --git a/README.md b/README.md index 71db02e..8e77633 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ An AngularJS app to search and view the Telegram API TL-schema in a beautiful wa ## Features - Search and view TL-schema constructors, types, and methods +- Community-driven documentation - Easy testing of constructors and methods with the playground - Easy access to `schema.json` and `schema.tl` - Always up-to-date @@ -21,4 +22,10 @@ Search is blazing fast since everything is local. You can use the playground on constructor and method pages to easily test the API with [Telegram for Devs](https://tjhorner.com/webogram). -![](https://i.imgur.com/vEBEWqq.png) \ No newline at end of file +![](https://i.imgur.com/vEBEWqq.png) + +### Documentation + +Anyone in the community can add documentation to constructors or methods. To do so, click the "Help document this method" button, make your changes, and submit a pull request. Simple as that! + +![](https://i.imgur.com/9vcRYxy.png) \ No newline at end of file diff --git a/views/constructors/show.html b/views/constructors/show.html index 74a42e0..45786dc 100644 --- a/views/constructors/show.html +++ b/views/constructors/show.html @@ -1,6 +1,10 @@

{{ constructor.predicate }}#{{ constructor.id | toHex }}

+ Help document this method + +
+

Fields