From fbc7ad0ae00df0cc09fd0157a915e2de24d84929 Mon Sep 17 00:00:00 2001 From: debugtalk Date: Tue, 19 May 2020 22:07:17 +0800 Subject: [PATCH] docs: update README --- README.md | 53 +++++++++++++++++++---------------------------------- 1 file changed, 19 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 0cfe8ca6..7ba2bf44 100644 --- a/README.md +++ b/README.md @@ -15,31 +15,23 @@ ## Design Philosophy -- 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 +- Convention over configuration +- ROI matters +- Embrace open source, leverage [`requests`][requests], [`pytest`][pytest], [`pydantic`][pydantic], [`allure`][allure] and [`locust`][locust]. ## Key Features -- 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 `variables`/`extract`/`validate` mechanisms to create full test scenarios. -- Supports perfect hook mechanism. -- 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. +- Inherit all powerful features of [`requests`][requests], just have fun to handle HTTP(S) in human way. +- Define testcase in YAML or JSON format, run with [`pytest`][pytest] in concise and elegant manner. +- Record and generate testcases with [`HAR`][HAR] support. +- Supports `variables`/`extract`/`validate`/`hooks` mechanisms to create extremely complex test scenarios. +- With `debugtalk.py` plugin, any function can be used in any part of your testcase. +- With [`jmespath`][jmespath], extract and validate json response has never been easier. +- With [`pytest`][pytest], hundreds of plugins are readily available. +- With [`allure`][allure], test report can be pretty nice and powerful. +- With reuse of [`locust`][locust], you can run performance test without extra work. - CLI command supported, perfect combination with `CI/CD`. -## Documentation - -HttpRunner is rich documented. - -- [`中文用户使用手册`][user-docs-zh] -- [`开发历程记录博客`][development-blogs] -- [CHANGELOG](docs/CHANGELOG.md) - ## Sponsors Thank you to all our sponsors! ✨🍰✨ ([become a sponsor](docs/sponsors.md)) @@ -58,25 +50,18 @@ Thank you to all our sponsors! ✨🍰✨ ([become a sponsor](docs/sponsors.md)) HttpRunner is in Sentry Sponsored plan. -## 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. -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. - ## Subscribe 关注 HttpRunner 的微信公众号，第一时间获得最新资讯。 ![](docs/assets/qrcode.jpg) -[Requests]: http://docs.python-requests.org/en/master/ -[unittest]: https://docs.python.org/3/library/unittest.html -[Locust]: http://locust.io/ -[har2case]: https://github.com/httprunner/har2case -[user-docs-zh]: http://docs.httprunner.org/ -[development-blogs]: http://debugtalk.com/tags/httprunner/ +[requests]: http://docs.python-requests.org/en/master/ +[pytest]: https://docs.pytest.org/ +[pydantic]: https://pydantic-docs.helpmanual.io/ +[locust]: http://locust.io/ +[jmespath]: https://jmespath.org/ +[allure]: https://docs.qameta.io/allure/ [HAR]: http://httparchive.org/ -[Swagger]: https://swagger.io/ +