Skip to content

Commit 64aa4f9

Browse files
authored
doc: update readme (#4055)
1 parent 8926f9c commit 64aa4f9

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

README.md

+14-16
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Reference: [Helpers API](https://github.com/codeceptjs/CodeceptJS/tree/master/do
2424
## Supercharged E2E Testing
2525

2626
CodeceptJS is a new testing framework for end-to-end testing with WebDriver (or others).
27-
It abstracts browser interaction to simple steps that are written from a user perspective.
27+
It abstracts browser interaction to simple steps that are written from a user's perspective.
2828
A simple test that verifies the "Welcome" text is present on a main page of a site will look like:
2929

3030
```js
@@ -57,27 +57,27 @@ And more to come...
5757

5858
CodeceptJS is a successor of [Codeception](http://codeception.com), a popular full-stack testing framework for PHP.
5959
With CodeceptJS your scenario-driven functional and acceptance tests will be as simple and clean as they can be.
60-
You don't need to worry about asynchronous nature of NodeJS or about various APIs of Selenium, Puppeteer, TestCafe, etc. as CodeceptJS unifies them and makes them work as they are synchronous.
60+
You don't need to worry about asynchronous nature of NodeJS or about various APIs of Playwright, Selenium, Puppeteer, TestCafe, etc. as CodeceptJS unifies them and makes them work as they are synchronous.
6161

6262

6363
## Features
6464

65-
* 🪄 **AI-powered** with GPT features to assist and heal failing tests
66-
* Based on [Mocha](https://mochajs.org/) testing framework.
67-
* Designed for scenario driven acceptance testing in BDD-style
68-
* Uses ES6 natively without transpiler.
65+
* 🪄 **AI-powered** with GPT features to assist and heal failing tests.
66+
* Based on [Mocha](https://mochajs.org/) testing framework.
67+
* 💼 Designed for scenario driven acceptance testing in BDD-style.
68+
* 💻 Uses ES6 natively without transpiler.
6969
* Also plays nice with TypeScript.
70-
* Smart locators: use names, labels, matching text, CSS or XPath to locate elements.
71-
* Interactive debugging shell: pause test at any point and try different commands in a browser.
70+
* </> Smart locators: use names, labels, matching text, CSS or XPath to locate elements.
71+
* 🌐 Interactive debugging shell: pause test at any point and try different commands in a browser.
7272
* Easily create tests, pageobjects, stepobjects with CLI generators.
7373

74-
## Install
74+
## Installation
7575

7676
```sh
7777
npm i codeceptjs --save
7878
```
7979

80-
Move to directory where you'd like to have your tests (and codeceptjs config) stored, and execute
80+
Move to directory where you'd like to have your tests (and CodeceptJS config) stored, and execute:
8181

8282
```sh
8383
npx codeceptjs init
@@ -131,8 +131,8 @@ Scenario('test some forms', ({ I }) => {
131131
});
132132
```
133133

134-
All actions are performed by I object; assertions functions start with `see` function.
135-
In this examples all methods of `I` are taken from WebDriver helper, see [reference](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/WebDriver.md) to learn how to use them.
134+
All actions are performed by `I` object; assertions functions start with `see` function.
135+
In these examples all methods of `I` are taken from WebDriver helper, see [reference](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/WebDriver.md) to learn how to use them.
136136

137137
Let's execute this test with `run` command. Additional option `--steps` will show us the running process. We recommend use `--steps` or `--debug` during development.
138138

@@ -198,17 +198,15 @@ In this case 'User is valid' string will be searched only inside elements locate
198198
### Grabbers
199199

200200
In case you need to return a value from a webpage and use it directly in test, you should use methods with `grab` prefix.
201-
They are expected to be used inside async/await functions, and their results will be available in test:
201+
They are expected to be used inside `async/await` functions, and their results will be available in test:
202202

203203
```js
204-
const assert = require('assert');
205-
206204
Feature('CodeceptJS Demonstration');
207205

208206
Scenario('test page title', async ({ I }) => {
209207
I.amOnPage('http://simple-form-bootstrap.plataformatec.com.br/documentation');
210208
const title = await I.grabTitle();
211-
assert.equal(title, 'Example application with SimpleForm and Twitter Bootstrap');
209+
I.expectEqual(title, 'Example application with SimpleForm and Twitter Bootstrap'); // Avaiable with Expect helper. -> https://codecept.io/helpers/Expect/
212210
});
213211
```
214212

0 commit comments

Comments
 (0)