Skip to content

Commit 427398f

Browse files
committed
Added TOC to README.md
1 parent 8267c3f commit 427398f

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,20 @@
22

33
This an official PHPUnit adapter for Allure Framework - a flexible, lightweight and multi-language framework for writing self-documenting tests.
44

5+
## Table of Contents
6+
* [What is this for?](#what-is-this-for)
7+
* [Example Project](#example-project)
8+
* [How to Generate Report](#how-to-generate-report)
9+
* [Installation and Usage](#installation-and-usage)
10+
* [Main Features](#main-features)
11+
* [Title](#human-readable-test-class-or-test-method-title)
12+
* [Description](#extended-test-class-or-test-method-description)
13+
* [Test severity](#set-test-severity)
14+
* [Test parameters](#specify-test-parameters-information)
15+
* [Features and Stories](#map-test-classes-and-test-methods-to-features-and-stories)
16+
* [Attachments](#attach-files-to-report)
17+
* [Steps](#divide-test-methods-into-steps)
18+
519
## What is this for?
620
The main purpose of this adapter is to accumulate information about your tests and write it out to a set of XML files: one for each test class. Then you can use a standalone command line tool or a plugin for popular continuous integration systems to generate an HTML page showing your tests in a good form.
721

0 commit comments

Comments
 (0)