From 5d9d1710eb15e5fa9236a0aa7be74c69362e08cc Mon Sep 17 00:00:00 2001 From: Guillaume Vincent Date: Sun, 17 Apr 2016 08:13:39 +0200 Subject: [PATCH] modify documentation --- README.md | 94 +++++++++++++++++++++++++++++++-------------------------------- 1 file changed, 47 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index 766376c..bd00dab 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,47 @@ -[![Build Status](https://travis-ci.org/lesspass/lesspass.svg?branch=master)](https://travis-ci.org/lesspass/lesspass) -# lesspass - -lesspass open source password manager (https://lesspass.com) - - -## lesspass submodules - - - [core](https://github.com/lesspass/core) : npm module with a clean api used to create passwords - - [backend](https://github.com/lesspass/api) : backend api used to store information about passwords - - [nginx](https://github.com/lesspass/nginx) : configuration for nginx - - -## requirements - - * git - * docker 1.10 - * docker-compose 1.6 - -## try lesspass on local - -clone application: - - git clone https://github.com/guillaumevincent/lesspass.git - cd lesspass - git submodule update --init - docker-compose up -d - -open the application in a browser: [http://localhost](http://localhost) - - -## tests - -run frontend tests - - cd frontend - npm install - npm test - - -## status - -| module | tests | -| --- | --- | -| [frontend](https://github.com/lesspass/lesspass) | [![Build Status](https://travis-ci.org/lesspass/lesspass.svg?branch=master)](https://travis-ci.org/lesspass/lesspass) | -| [core](https://github.com/lesspass/core) | [![Build Status](https://travis-ci.org/lesspass/core.svg?branch=master)](https://travis-ci.org/lesspass/core) | -| [backend](https://github.com/lesspass/api) | [![Build Status](https://travis-ci.org/lesspass/api.svg?branch=master)](https://travis-ci.org/lesspass/api) | +[![Build Status](https://travis-ci.org/lesspass/lesspass.svg?branch=master)](https://travis-ci.org/lesspass/lesspass) +# lesspass + +lesspass open source password manager (https://lesspass.com) + + +## lesspass submodules + + - [core](https://github.com/lesspass/core) : npm module with a clean api used to create passwords + - [backend](https://github.com/lesspass/api) : backend api used to store information about passwords + - [nginx](https://github.com/lesspass/nginx) : configuration for nginx + + +## requirements + + * git + * docker 1.10 + * docker-compose 1.6 + +## try lesspass on local + +clone application: + + git clone https://github.com/guillaumevincent/lesspass.git + cd lesspass + git submodule update --init + docker-compose up -d + +open the application in a browser: [https://localhost](https://localhost) + + +## tests + +run frontend tests + + cd frontend + npm install + npm test + + +## status + +| module | tests | +| --- | --- | +| [frontend](https://github.com/lesspass/lesspass) | [![Build Status](https://travis-ci.org/lesspass/lesspass.svg?branch=master)](https://travis-ci.org/lesspass/lesspass) | +| [core](https://github.com/lesspass/core) | [![Build Status](https://travis-ci.org/lesspass/core.svg?branch=master)](https://travis-ci.org/lesspass/core) | +| [backend](https://github.com/lesspass/api) | [![Build Status](https://travis-ci.org/lesspass/api.svg?branch=master)](https://travis-ci.org/lesspass/api) |