From ab7011f4b0741ca5a2ba28d42d70cf47dc52a298 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ny=CC=88co?= Date: Wed, 5 Aug 2015 17:07:36 +0200 Subject: [PATCH] README update * cross-reference * naming explaination --- README.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9ae122b..9c4a0dd 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,14 @@ -Test suite for ESL's branch of ejabberd -======================================= +# Mercutio [![Build Status](https://travis-ci.org/esl/ejabberd_tests.svg?branch=master)](https://travis-ci.org/esl/ejabberd_tests) -This repository contains test code for ejabberd/MongooseIM. -It's used mainly for [ESL's branch of ejabberd](https://github.com/esl/MongooseIM), +This repository contains test code for MongooseIM and ejabberd. + +It is used mainly for [ESL's MongooseIM](https://github.com/esl/MongooseIM), but one that may be reused in other projects. +This tool, mercutio, is using the [ESL's escalus](https://github.com/esl/escalus) XMPP client, and can be used by [ESL's amoc](https://github.com/esl/amoc) for load tests. + ## How to run tests + There are 2 ways of running the tests: * quick (`make quicktest`) - this command tests the current configuration of the server * full (`make test`) - this command tests all server configurations defined in test.config file - [see the section on various server configurations](#testing-various-server-configurations) @@ -37,7 +40,7 @@ In order to do this define configuration variables in `test.config` file, for ex {auth_method, "internal"}]} ]}. ``` -For each configuration the given variables merged with values from `node1_vars.config` +For each configuration the given variables merged with values from `node1_vars.config` will be overlaid with the original `ejabberd.cfg` file and ejabberd will be restarted. @@ -91,3 +94,10 @@ In the `end_per_suite` previously backuped config file is restored and the server is restarted again. See [ejabberd_node_utils](tests/ejabberd_node_utils.erl) for more information. +# Naming + +According to [Wikipedia](https://en.wikipedia.org/wiki/Characters_in_Romeo_and_Juliet#Mercutio), Mercutio, of the House Escalus, is the cousin of Prince Escalus, and is a close friend of Romeo Montague. + +It follows the great tradition to use characters of William Shakespeare's Romeo and Juliet in the XMPP specifications. + +mercutio's former name was 'ejabberd_tests'.