Skip to content

Commit 000791e

Browse files
committed
minor modification on introduction
1 parent 7a5f4dc commit 000791e

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

docs/introduction.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ title: Introduction
44

55
![chkware | Test management for api era](./assets/github-hero-01.png)
66

7-
**chkware** (pronounced as */check:ware/*) is an API testing tool, a scriptable HTTP client, and a test specification management tool for the API era.
7+
8+
*CHKware* (pronounced as */check:ware/*) is a low-code API testing tool, a script-able HTTP client, and an API test automation tool for the API era.
89

910
It is available as a command-line application. You write test specification files in a [YAML](https://yaml.org/)-based [DSL](https://en.wikipedia.org/wiki/Domain-specific_language). In that specification file you will define some structured configurations to be used for the following purpose:
1011

1112
- Create reusable http request specification. [alpha]
12-
- Create reusable test specifications. [TBD]
13+
- Create reusable test specifications. [alpha]
1314

14-
Afterward, you run those test specification files with **chkware**, and get test results or even reuse them.
15+
Afterward, you run those test specification files with *CHKware*, and get test results or even reuse them.
1516

1617
---
17-
1818
### Motivation
1919

2020
In today's world, API is one of the key fuels that drive business. It is the way web applications consume services from self-hosted or 3rd-party vendors. Recent technology movements are going to a fluid internet direction, where *vendor_A* have one API, *vendor_B* is another API provider, while we are the consumers (e-commerce, fin-tech) of those vendor APIs. We use those APIs to host our contents based on those APIs. Maybe we are *vendor_U* hosting more complex APIs on top of those. So, with the upcoming complexity of integration we need better tooling for API testing. Testing tools for modularize api testing.
@@ -29,13 +29,13 @@ For these reasons, the solutions are less scaling for actual use-cases. With add
2929
2. Added complexity of maintaining supporting software stack, so there are side effects
3030
3. Above all, maintaining test cases based on code is more complex if you don't design your test code architecture well in the early days.
3131

32-
So, clearly enough I think this situation needs to be improved. This is the motivation for **chkware**.
32+
So, clearly enough I think this situation needs to be improved. This is the motivation for *CHKware*.
3333

3434
---
3535

3636
### Audiences
3737

38-
The focused users of **chkware** are everyone involved in an API project, given they have some testing basics.
38+
The focused users of **CHKware** are everyone involved in an API project, given they have some testing basics.
3939

4040
- People with zero programming knowledge need a tool that does not get in their way.
4141
- We need a tool that is relatively easy to write specifications, expressive, and customizable to the very core.
@@ -44,7 +44,7 @@ The focused users of **chkware** are everyone involved in an API project, given
4444
In practical cases, software testers / QAs, developers, PM/POs, are the people who should be able to use it rigorously.
4545

4646
- This project is particularly helpful if you are developing an API oriented project.
47-
- Test websites or web interfaces are not in the project focus for now.
47+
- Writing specification to test websites, or web interfaces are not in the project focus for now.
4848
- Also, seeding data, validating data in DB is out of this project scope for now.
4949

5050
---
@@ -63,5 +63,5 @@ There is no native binary dependency, therefore it is expected on all the platfo
6363

6464
Command name | Specification document | Stability
6565
---|---|---
66-
`http`| Http | _`Alpha`_
67-
`testcase`| Testcase | _`Pre-Alpha`_
66+
`http`| Http | _alpha_
67+
`testcase`| Testcase | _alpha_

0 commit comments

Comments
 (0)