Skip to content

Commit

Permalink
[GitHub Actions Automated] Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Danang Galuh Tegar Prasetyo committed Dec 8, 2021
1 parent 4c6f87d commit 75f6bfc
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -110,10 +110,10 @@ <h3> </h3>
<section>
<article><h1>SimpleCrypto</h1>
<p><a href="https://github.com/danang-id/simple-crypto-js/releases"><img src="https://img.shields.io/github/release/danang-id/simple-crypto-js.svg" alt="GitHub Release"></a>
<a href="https://travis-ci.org/danang-id/simple-crypto-js"><img src="https://travis-ci.org/danang-id/simple-crypto-js.svg?branch=master" alt="Build Status"></a>
<a href="https://github.com/danang-id/simple-crypto-js/actions/workflows/build-distribution.yml"><img src="https://github.com/danang-id/simple-crypto-js/actions/workflows/build-distribution.yml/badge.svg" alt="Build Distribution"></a>
<a href="https://coveralls.io/github/danang-id/simple-crypto-js?branch=master"><img src="https://coveralls.io/repos/github/danang-id/simple-crypto-js/badge.svg?branch=master" alt="Coverage Status"></a>
<a href="https://www.npmjs.com/package/simple-crypto-js?activeTab=dependencies"><img src="https://img.shields.io/librariesio/release/npm/simple-crypto-js" alt="Dependencies Status"></a></p>
<p><a href="https://www.npmjs.com/package/simple-crypto-js?activeTab=versions"><img src="https://img.shields.io/npm/v/simple-crypto-js.svg" alt="NPM Version"></a>
<a href="https://www.npmjs.com/package/simple-crypto-js?activeTab=dependencies"><img src="https://img.shields.io/librariesio/release/npm/simple-crypto-js/latest.svg" alt="Dependencies Status"></a></p>
<p><a href="https://www.npmjs.com/package/simple-crypto-js"><img src="https://img.shields.io/npm/v/simple-crypto-js/latest.svg" alt="NPM Version"></a>
<a href="#license"><img src="https://img.shields.io/npm/l/simple-crypto-js.svg" alt="License"></a>
<a href="https://www.npmjs.com/package/simple-crypto-js"><img src="https://img.shields.io/npm/dm/simple-crypto-js.svg" alt="Monthly Downloads"></a></p>
<p><strong><em>SimpleCrypto</em></strong> is a JavaScript library that simplify the process of encryption and decryption of JavaScript objects, as simple as just calling <code>encrypt()</code> and <code>decrypt()</code> function. This library implements brix's <a href="https://github.com/brix/crypto-js">crypto-js</a> library. This library is pure JavaScript library built with TypeScript targeting CommonJS ECMAScript 5 (ES5), so it is compatible with most NodeJS back-end applications or JavaScript front-end (client browser).</p>
Expand All @@ -124,12 +124,12 @@ <h2>Breaking Changes</h2>
<p>SimpleCrypto v3.0.0 onward will use new <code>crypto-js</code> dependency version <code>^4.0.0</code>. This version of <code>crypto-js</code> replaces <code>Math.random()</code> method with native crypto module. Because of this, <strong>SimpleCrypto might not be able to run on some environments without native crypto module support, such as IE 10 (and earlier) or React Native</strong>.</p>
<p>Please <a href="https://github.com/brix/crypto-js#400">read more here</a>.</p>
<h2>Getting Started</h2>
<p>This library is available through <a href="https://cdn.jsdelivr.net/npm/simple-crypto-js@2.5.0/dist/SimpleCrypto.min.js">jsDelivr CDN</a> and package manager (like <a href="https://www.npmjs.org/">npm</a> or <a href="https://www.yarnpkg.com/">yarn</a>).</p>
<p>This library is available through <a href="https://cdn.jsdelivr.net/npm/simple-crypto-js@legacy/dist/SimpleCrypto.min.js">jsDelivr CDN</a> and package manager (like <a href="https://www.npmjs.org/">npm</a> or <a href="https://www.yarnpkg.com/">yarn</a>).</p>
<h3>Vanilla JavaScript + HTML</h3>
<p>To get started, add SimpleCrypto script to your HTML page. Only SimpleCrypto prior to version 3.0.0 is supported.</p>
<p>To get started, add SimpleCrypto script to your HTML page. <strong>Only legacy version of SimpleCrypto is supported.</strong></p>
<pre class="prettyprint source lang-html"><code>&lt;head>
&lt;!-- Another line -->
&lt;script src=&quot;//cdn.jsdelivr.net/npm/simple-crypto-js@2.5.0/dist/SimpleCrypto.min.js&quot;>&lt;/script>
&lt;script src=&quot;//cdn.jsdelivr.net/npm/simple-crypto-js@legacy/dist/SimpleCrypto.min.js&quot;>&lt;/script>
&lt;!-- Another line -->
&lt;/head>
</code></pre>
Expand Down

0 comments on commit 75f6bfc

Please sign in to comment.