mirror of
https://github.com/crypto-pro-web/crypto-pro-js.git
synced 2024-11-24 00:55:00 +03:00
Исправления в readme
This commit is contained in:
parent
bbd5434cec
commit
31669dd18f
89
README.md
89
README.md
@ -5,11 +5,11 @@
|
|||||||
|
|
||||||
<a name="cryptopro"></a>
|
<a name="cryptopro"></a>
|
||||||
# cryptoPro
|
# cryptoPro
|
||||||
Единое, асинхронное API для взаимодействия с КриптоПРО ЭЦП Browser Plug-In
|
Асинхронный JavaScript API для работы с КриптоПРО ЭЦП Browser Plug-In
|
||||||
|
|
||||||
> :warning: **Это форк проекта [vgoma/crypto-pro](https://github.com/vgoma/crypto-pro)**
|
> **Это форк проекта [vgoma/crypto-pro](https://github.com/vgoma/crypto-pro)**
|
||||||
>
|
>
|
||||||
> :warning: **API форка отличается от оригинала**: внимательно читайте README
|
> **API форка отличается от оригинала**: внимательно читайте README
|
||||||
|
|
||||||
| [![Chrome](https://raw.githubusercontent.com/alrra/browser-logos/62.2.25/src/chrome/chrome_64x64.png)](https://www.chromium.org/getting-involved/download-chromium#TOC-Downloading-old-builds-of-Chrome-Chromium) | [![Firefox](https://raw.githubusercontent.com/alrra/browser-logos/62.2.25/src/firefox/firefox_64x64.png)](https://ftp.mozilla.org/pub/firefox/releases/) | [![IE](https://raw.githubusercontent.com/alrra/browser-logos/62.2.25/src/archive/internet-explorer_9-11/internet-explorer_9-11_64x64.png)](https://www.microsoft.com/ru-ru/download/details.aspx?id=43374) | [![Opera](https://raw.githubusercontent.com/alrra/browser-logos/62.2.25/src/opera/opera_64x64.png)](http://get.opera.com/ftp/pub/opera/desktop/) |
|
| [![Chrome](https://raw.githubusercontent.com/alrra/browser-logos/62.2.25/src/chrome/chrome_64x64.png)](https://www.chromium.org/getting-involved/download-chromium#TOC-Downloading-old-builds-of-Chrome-Chromium) | [![Firefox](https://raw.githubusercontent.com/alrra/browser-logos/62.2.25/src/firefox/firefox_64x64.png)](https://ftp.mozilla.org/pub/firefox/releases/) | [![IE](https://raw.githubusercontent.com/alrra/browser-logos/62.2.25/src/archive/internet-explorer_9-11/internet-explorer_9-11_64x64.png)](https://www.microsoft.com/ru-ru/download/details.aspx?id=43374) | [![Opera](https://raw.githubusercontent.com/alrra/browser-logos/62.2.25/src/opera/opera_64x64.png)](http://get.opera.com/ftp/pub/opera/desktop/) |
|
||||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
@ -44,22 +44,22 @@
|
|||||||
## Установка
|
## Установка
|
||||||
Для NPM:
|
Для NPM:
|
||||||
```bash
|
```bash
|
||||||
npm install crypto-pro
|
npm install crypto-pro-js
|
||||||
```
|
```
|
||||||
|
|
||||||
Для Yarn:
|
Для Yarn:
|
||||||
```bash
|
```bash
|
||||||
yarn add crypto-pro
|
yarn add crypto-pro-js
|
||||||
```
|
```
|
||||||
|
|
||||||
Для Bower:
|
Для Bower:
|
||||||
```bash
|
```bash
|
||||||
bower install crypto-pro
|
bower install webmasterskaya/crypto-pro-js
|
||||||
```
|
```
|
||||||
|
|
||||||
Подключение пакета как UMD модуля через тэг script:
|
Подключение пакета как UMD модуля через тэг script:
|
||||||
```html
|
```html
|
||||||
<script src="crypto-pro/dist/crypto-pro.min.js"></script>
|
<script src="crypto-pro-js/dist/crypto-pro.min.js"></script>
|
||||||
<script>
|
<script>
|
||||||
window.cryptoPro.getUserCertificates()
|
window.cryptoPro.getUserCertificates()
|
||||||
.then(function (certificates) {
|
.then(function (certificates) {
|
||||||
@ -73,7 +73,7 @@ window.cryptoPro.getUserCertificates()
|
|||||||
|
|
||||||
Подключение пакета как ES модуля с Typescript или JavaScript:
|
Подключение пакета как ES модуля с Typescript или JavaScript:
|
||||||
```typescript
|
```typescript
|
||||||
import { getUserCertificates, Certificate } from 'crypto-pro';
|
import { getUserCertificates, Certificate } from 'crypto-pro-js';
|
||||||
|
|
||||||
(async () => {
|
(async () => {
|
||||||
let certificates: Certificate[];
|
let certificates: Certificate[];
|
||||||
@ -135,43 +135,6 @@ npm i
|
|||||||
npm start
|
npm start
|
||||||
```
|
```
|
||||||
|
|
||||||
<a name="example-angular"></a>
|
|
||||||
### Angular (ES Modules + Typescript)
|
|
||||||
```bash
|
|
||||||
cd examples/angular
|
|
||||||
npm i
|
|
||||||
```
|
|
||||||
|
|
||||||
Запуск в режиме разработки:
|
|
||||||
```bash
|
|
||||||
npm start
|
|
||||||
```
|
|
||||||
|
|
||||||
Запуск в продакшн режиме:
|
|
||||||
```bash
|
|
||||||
npm run build
|
|
||||||
npm run serve
|
|
||||||
```
|
|
||||||
|
|
||||||
<a name="example-react"></a>
|
|
||||||
### React (ES Modules + JavaScript)
|
|
||||||
```bash
|
|
||||||
cd examples/react
|
|
||||||
npm i
|
|
||||||
```
|
|
||||||
|
|
||||||
Запуск в режиме разработки:
|
|
||||||
```bash
|
|
||||||
npm start
|
|
||||||
```
|
|
||||||
|
|
||||||
Запуск в продакшн режиме:
|
|
||||||
```bash
|
|
||||||
npm run build
|
|
||||||
npm run serve
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
<a name="developers"></a>
|
<a name="developers"></a>
|
||||||
# Тем, кто хочет помочь
|
# Тем, кто хочет помочь
|
||||||
Буду благодарен за расширение/улучшение/доработку API.
|
Буду благодарен за расширение/улучшение/доработку API.
|
||||||
@ -200,7 +163,7 @@ npm i
|
|||||||
npm link ../../
|
npm link ../../
|
||||||
npm start
|
npm start
|
||||||
```
|
```
|
||||||
> После выполнения `npm link ../../` в директории `examples/script-tag/node_modules` папка `crypto-pro` станет ярлыком,
|
> После выполнения `npm link ../../` в директории `examples/script-tag/node_modules` папка `crypto-pro-js` станет ярлыком,
|
||||||
> указывающим на папку содержащую локально собранный пакет.
|
> указывающим на папку содержащую локально собранный пакет.
|
||||||
|
|
||||||
<a name="tests-execution"></a>
|
<a name="tests-execution"></a>
|
||||||
@ -210,32 +173,6 @@ npm start
|
|||||||
npm test
|
npm test
|
||||||
```
|
```
|
||||||
|
|
||||||
<a name="examples-testing"></a>
|
|
||||||
## Проверка работы примеров с React и Angular
|
|
||||||
React и Angular используют версию сборки пакета в формате ES модулей из директории `lib/`.
|
|
||||||
Для их запуска необходимо сначала собрать пакет выполнив:
|
|
||||||
```bash
|
|
||||||
npm run build
|
|
||||||
```
|
|
||||||
|
|
||||||
После этого из папки `examples/angular` или `examples/react` залинковать пакет:
|
|
||||||
```bash
|
|
||||||
cd examples/angular
|
|
||||||
npm i
|
|
||||||
npm link ../../
|
|
||||||
```
|
|
||||||
|
|
||||||
И запустить пример в одном из двух режимов. В режиме разработки:
|
|
||||||
```bash
|
|
||||||
npm start
|
|
||||||
```
|
|
||||||
|
|
||||||
или в режиме продакшн:
|
|
||||||
```bash
|
|
||||||
npm run build
|
|
||||||
npm run serve
|
|
||||||
```
|
|
||||||
|
|
||||||
<a name="final-check"></a>
|
<a name="final-check"></a>
|
||||||
## Проверка пакета перед публикацией в NPM
|
## Проверка пакета перед публикацией в NPM
|
||||||
Необходимо протестировать работу в заявленных браузерах, сделав это на локально запакованной версии пакета.
|
Необходимо протестировать работу в заявленных браузерах, сделав это на локально запакованной версии пакета.
|
||||||
@ -268,7 +205,7 @@ npm unlink
|
|||||||
[npm-version-image]: https://img.shields.io/npm/v/crypto-pro-js.svg?style=flat
|
[npm-version-image]: https://img.shields.io/npm/v/crypto-pro-js.svg?style=flat
|
||||||
[npm-downloads-image]: http://img.shields.io/npm/dm/crypto-pro-js.svg?style=flat
|
[npm-downloads-image]: http://img.shields.io/npm/dm/crypto-pro-js.svg?style=flat
|
||||||
[downloads-url]: https://npmcharts.com/compare/crypto-pro-js?minimal=true
|
[downloads-url]: https://npmcharts.com/compare/crypto-pro-js?minimal=true
|
||||||
[travis-url]: https://www.travis-ci.com/kernusr/crypto-pro-js
|
[travis-url]: https://www.travis-ci.com/webmasterskaya/crypto-pro-js
|
||||||
[travis-image]: http://img.shields.io/travis/kernusr/crypto-pro-js/master.svg?style=flat
|
[travis-image]: http://img.shields.io/travis/webmasterskaya/crypto-pro-js/master.svg?style=flat
|
||||||
[coveralls-image]: https://coveralls.io/repos/github/kernusr/crypto-pro-js/badge.svg?branch=master
|
[coveralls-image]: https://coveralls.io/repos/github/webmasterskaya/crypto-pro-js/badge.svg?branch=master
|
||||||
[coveralls-url]: https://coveralls.io/github/kernusr/crypto-pro-js?branch=master
|
[coveralls-url]: https://coveralls.io/github/webmasterskaya/crypto-pro-js?branch=master
|
||||||
|
Loading…
Reference in New Issue
Block a user