From 7c272890b2481e1e8831478f24a96830791450c0 Mon Sep 17 00:00:00 2001 From: "I. Dan Calinescu" Date: Thu, 15 Feb 2018 07:55:36 +0200 Subject: [PATCH] added code syntax --- README.md | 3 +-- docs/README.md | 2 +- docs/vault/README.md | 12 ++++++------ 3 files changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index b54723c..2e84b46 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,6 @@
## Latest Release [![Build](https://circleci.com/gh/fluidtrends/cassi.svg?style=svg)](https://circleci.com/gh/fluidtrends/cassi) - [![Coverage](https://api.codeclimate.com/v1/badges/f472b929f316ff5f2d76/test_coverage)](https://codeclimate.com/github/fluidtrends/cassi/test_coverage) [![Maintainability](https://api.codeclimate.com/v1/badges/f472b929f316ff5f2d76/maintainability)](https://codeclimate.com/github/fluidtrends/cassi/maintainability) [![Style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com) @@ -18,7 +17,7 @@ There's really nothing to getting Cassi up and running, other than selecting a root directory for your vault storage and setting a password for each vault. Have a look at how easy it is to create a Cassi Vault: -``` +```javascript // Import Cassi const cassi = require('cassi') diff --git a/docs/README.md b/docs/README.md index bb38dba..d76b4dd 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,7 +8,7 @@ A Cassi Vault is a JSON file structure that can be encrypted, decrypted and pass **Basic Usage** -``` +```javascript // Import Cassi const cassi = require('cassi') diff --git a/docs/vault/README.md b/docs/vault/README.md index f59348c..cbd6d3c 100644 --- a/docs/vault/README.md +++ b/docs/vault/README.md @@ -8,7 +8,7 @@ To use a Vault you start by instantiating an instance, with some options. *Examples:* -``` +```javascript // Import Cassi with default options const cassi = require('cassi') @@ -28,7 +28,7 @@ Create a Cassi Vault in your home directory (~/.cassi), with the given password **Example:** -``` +```javascript vault.create('hello') .then(({ vault, mnemonic }) => { // Have fun using your new vault. @@ -47,7 +47,7 @@ Lock a Cassi Vault with the given password **Example:** -``` +```javascript vault.lock('hello') .then(({ vault }) => { // the vault is successfully locked now @@ -65,7 +65,7 @@ Unlock a Cassi Vault with the given password **Example:** -``` +```javascript vault.unlock('hello') .then(({ vault }) => { // you may use the vault now @@ -81,7 +81,7 @@ Read secure data from an unlocked vault **Example:** -``` +```javascript const name = vault.read('name') ``` @@ -91,7 +91,7 @@ Write secure data from to an unlocked vault **Example:** -``` +```javascript vault.write('name', 'Johnny') ```