diff --git a/README.md b/README.md index a205fae7..c932b118 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,11 @@ [![pyversions](https://img.shields.io/pypi/pyversions/httprunner.svg)](https://pypi.python.org/pypi/httprunner) [![TesterHome](https://img.shields.io/badge/TTF-TesterHome-2955C5.svg)](https://testerhome.com/github_statistics) -HttpRunner is an HTTP(S) protocol-oriented universal testing framework. Write testing scripts in `YAML/JSON` once, you can then achieve automated testing, performance testing, online monitoring, continuous integration and other testing needs. - -Formerly known as `ApiTestEngine`. +*HttpRunner* is a simple & elegant, yet powerful HTTP(S) testing framework. Enjoy! ✨ 🚀 ✨ ## Design Philosophy -- Take full reuse of Python's existing powerful libraries: [`Requests`][Requests], [`unittest`][unittest] and [`Locust`][Locust]. +- Embrace open source, stand on giants' shoulders, like [`Requests`][Requests], [`unittest`][unittest] and [`Locust`][Locust]. - Convention over configuration. - Pursuit of high rewards, write once and achieve a variety of testing needs @@ -23,9 +21,9 @@ Formerly known as `ApiTestEngine`. - Inherit all powerful features of [`Requests`][Requests], just have fun to handle HTTP(S) in human way. - Define testcases in YAML or JSON format in concise and elegant manner. - Record and generate testcases with [`HAR`][HAR] support. see [`har2case`][har2case]. -- Supports `function`/`variable`/`extract`/`validate` mechanisms to create full test scenarios. +- Supports `variables`/`extract`/`validate` mechanisms to create full test scenarios. - Supports perfect hook mechanism. -- With `debugtalk.py` plugin, module functions can be auto-discovered in recursive upward directories. +- With `debugtalk.py` plugin, very easy to implement complex logic in testcase. - Testcases can be run in diverse ways, with single testcase, multiple testcases, or entire project folder. - Test report is concise and clear, with detailed log records. - With reuse of [`Locust`][Locust], you can run performance test without extra work. @@ -35,33 +33,28 @@ Formerly known as `ApiTestEngine`. HttpRunner is rich documented. -- [`User documentation in English (outdated)`][user-docs-en] - [`中文用户使用手册`][user-docs-zh] - [`开发历程记录博客`][development-blogs] ## How to Contribute -1. Check for [open issues](https://github.com/HttpRunner/HttpRunner/issues) or [open a fresh issue](https://github.com/HttpRunner/HttpRunner/issues/new/choose) to start a discussion around a feature idea or a bug. +1. Check for [open issues](https://github.com/httprunner/httprunner/issues) or [open a fresh issue](https://github.com/httprunner/httprunner/issues/new/choose) to start a discussion around a feature idea or a bug. 2. Fork [the repository](https://github.com/httprunner/httprunner) on GitHub to start making your changes to the **master** branch (or branch off of it). You also need to comply with the [development rules](https://github.com/httprunner/docs/blob/master/en/docs/dev-rules.md). 3. Write a test which shows that the bug was fixed or that the feature works as expected. -4. Send a pull request, you will then become a [contributor](https://github.com/HttpRunner/HttpRunner/graphs/contributors) after it gets merged and published. +4. Send a pull request, you will then become a [contributor](https://github.com/httprunner/httprunner/graphs/contributors) after it gets merged and published. ## Subscribe 关注 HttpRunner 的微信公众号,第一时间获得最新资讯。 -![][qrcode_for_httprunner] +![](httprunner/templates/qrcode.jpg) [Requests]: http://docs.python-requests.org/en/master/ [unittest]: https://docs.python.org/3/library/unittest.html [Locust]: http://locust.io/ -[PyUnitReport]: https://github.com/HttpRunner/PyUnitReport -[Jenkins]: https://jenkins.io/index.html -[har2case]: https://github.com/HttpRunner/har2case -[user-docs-en]: http://httprunner.org/ +[har2case]: https://github.com/httprunner/har2case [user-docs-zh]: http://cn.httprunner.org/ -[development-blogs]: http://debugtalk.com/tags/HttpRunner/ +[development-blogs]: http://debugtalk.com/tags/httprunner/ [HAR]: http://httparchive.org/ [Swagger]: https://swagger.io/ -[Postman Collection Format]: http://blog.getpostman.com/2015/06/05/travelogue-of-postman-collection-format-v2/ -[qrcode_for_httprunner]: https://raw.githubusercontent.com/HttpRunner/HttpRunner/master/docs/images/qrcode_for_httprunner.jpg + diff --git a/httprunner/templates/qrcode.jpg b/httprunner/templates/qrcode.jpg new file mode 100644 index 00000000..386a237d Binary files /dev/null and b/httprunner/templates/qrcode.jpg differ