diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..357d994 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +# The MIT License (MIT) + +Copyright © 2022 Tii + +> Permission is hereby granted, free of charge, to any person obtaining a copy +> of this software and associated documentation files (the "Software"), to deal +> in the Software without restriction, including without limitation the rights +> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +> copies of the Software, and to permit persons to whom the Software is +> furnished to do so, subject to the following conditions: +> +> The above copyright notice and this permission notice shall be included in +> all copies or substantial portions of the Software. +> +> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +> THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..d640dd4 --- /dev/null +++ b/README.md @@ -0,0 +1,136 @@ + + + +[![Contributors][contributors-shield]][contributors-url] +[![Forks][forks-shield]][forks-url] +[![Stargazers][stars-shield]][stars-url] +[![Issues][issues-shield]][issues-url] +[![MIT License][license-shield]][license-url] + + + + +
+
+

Telepath

+ +

+ Create Telegram Bots with this modern PHP library +
+ Explore the docs » +
+
+ Report Bug + · + Request Feature +

+
+ + + + +
+ Table of Contents +
    +
  1. + About The Project +
    2. +
  2. + Before You Start +
    3. +
  3. Usage
    4. +
  4. Contributing
    5. +
  5. License
    6. +
  6. Contact
    7. +
+
+ + + + +## About The Project + +Telepath is a modern framework-agnostic libraray to create Telegram Bots in PHP. + +It stands out by generating a lot of PHP Code automatically from the [Telegram Bot API documentation][bot-api] and using modern PHP features like Attributes and Named Parameters. + +

(back to top)

+ + + + +## Before You Start + +We want to make use of modern PHP all the way but the development of PHP doesn't stop. This means if there will be a feature in a new PHP version that makes sense to use in this package, we will. + +**So beware of that and only use this library if you're running in a setup where you can easily upgrade to new PHP versions when they get released.** + +

(back to top)

+ + + + +## Usage + +1. Require this package with `composer require telepath/telepath` +2. Create an instance and pass it your Bot API Token via `$bot = new TelegramBot($token);` +3. Call all available methods of the [Telegram Bot API][bot-api] via the Bot Instance, like `$bot->sendMessage($chatId, $text);` + +_For a more detailled look including how to receive and react to messages and commands, have a look into our [Documentation][docs]_ + +

(back to top)

+ + + + +## Contributing + +Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. + +If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". +Don't forget to give the project a star! Thanks again! + +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) +4. Push to the Branch (`git push origin feature/AmazingFeature`) +5. Open a Pull Request + +

(back to top)

+ + + + +## License + +Distributed under the MIT License. See [LICENSE.md](LICENSE.md) for more information. + +

(back to top)

+ + + + +## Contact + +Tii - [@TiiFuchs](https://twitter.com/TiiFuchs) - mail@tii.one + +Project Link: [https://github.com/telepath-php/telepath](https://github.com/telepath-php/telepath) + +

(back to top)

+ + + + +[contributors-shield]: https://img.shields.io/github/contributors/telepath-php/telepath.svg?style=for-the-badge +[contributors-url]: https://github.com/telepath-php/telepath/graphs/contributors +[forks-shield]: https://img.shields.io/github/forks/telepath-php/telepath.svg?style=for-the-badge +[forks-url]: https://github.com/telepath-php/telepath/network/members +[stars-shield]: https://img.shields.io/github/stars/telepath-php/telepath.svg?style=for-the-badge +[stars-url]: https://github.com/telepath-php/telepath/stargazers +[issues-shield]: https://img.shields.io/github/issues/telepath-php/telepath.svg?style=for-the-badge +[issues-url]: https://github.com/telepath-php/telepath/issues +[license-shield]: https://img.shields.io/github/license/telepath-php/telepath.svg?style=for-the-badge +[license-url]: https://github.com/telepath-php/telepath/blob/master/LICENSE.txt + +[bot-api]: https://core.telegram.org/bots/api +[docs]: https://telepath-php.dev \ No newline at end of file diff --git a/telepathy b/telepathy deleted file mode 100755 index 02c10ca..0000000 Binary files a/telepathy and /dev/null differ