Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sop committed May 20, 2019
1 parent ecece5b commit 433dc87
Show file tree
Hide file tree
Showing 8 changed files with 103 additions and 89 deletions.
2 changes: 1 addition & 1 deletion .editorconfig
Expand Up @@ -2,5 +2,5 @@
tab_width = 4
end_of_line = lf

[*.{php}]
[*.{php,json,xml.dist}]
indent_style = space
16 changes: 12 additions & 4 deletions .gitignore
@@ -1,15 +1,23 @@
# eclipse project files
# Eclipse project files
/.settings/
/.buildpath
/.project
/.pydevproject

# build
# VS Code
/.vscode

# build files
/build/
/.*.cache

# composer
# Composer
/vendor/
/composer.lock

# non-dist files
/phpunit.xml
/.php_cs

# sandbox
/demo/
/demo/
30 changes: 20 additions & 10 deletions .scrutinizer.yml
@@ -1,17 +1,27 @@
build:
nodes:
analysis:
tests:
override:
- php-scrutinizer-run
tests-and-coverage:
requires:
- node: analysis
tests:
override:
- command: vendor/bin/phpunit
coverage:
format: clover
file: build/logs/clover.xml
environment:
php:
version: 7.0.20
tests:
override:
- command: vendor/bin/phpunit
coverage:
format: php-clover
file: build/logs/clover.xml
version: 7.0
filter:
excluded_paths:
- test/
dependency_paths:
- vendor/
checks:
php:
code_rating: true
duplication: false
filter:
excluded_paths:
- test/
4 changes: 2 additions & 2 deletions .travis.yml
Expand Up @@ -6,6 +6,6 @@ php:
- "7.3"
before_script:
- "composer install"
- "composer require satooshi/php-coveralls"
- "composer require php-coveralls/php-coveralls"
after_success:
- "travis_retry php vendor/bin/coveralls -v"
- "travis_retry php vendor/bin/php-coveralls -v"
2 changes: 1 addition & 1 deletion LICENSE
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2016-2017 Joni Eskelinen
Copyright (c) 2016-2019 Joni Eskelinen

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
20 changes: 10 additions & 10 deletions README.md
@@ -1,24 +1,24 @@
[![Build Status](https://travis-ci.org/sop/crypto-bridge.svg?branch=master)](https://travis-ci.org/sop/crypto-bridge)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/sop/crypto-bridge/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/sop/crypto-bridge/?branch=master)
[![Coverage Status](https://coveralls.io/repos/github/sop/crypto-bridge/badge.svg?branch=master)](https://coveralls.io/github/sop/crypto-bridge?branch=master)
[![License](https://poser.pugx.org/sop/crypto-bridge/license)](https://github.com/sop/crypto-bridge/blob/master/LICENSE)

# CryptoBridge

[![Build Status](https://travis-ci.org/sop/crypto-bridge.svg?branch=php70)](https://travis-ci.org/sop/crypto-bridge)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/sop/crypto-bridge/badges/quality-score.png?b=php70)](https://scrutinizer-ci.com/g/sop/crypto-bridge/?branch=php70)
[![Coverage Status](https://coveralls.io/repos/github/sop/crypto-bridge/badge.svg?branch=php70)](https://coveralls.io/github/sop/crypto-bridge?branch=php70)
[![License](https://poser.pugx.org/sop/crypto-bridge/license)](https://github.com/sop/crypto-bridge/blob/php70/LICENSE)

A PHP library providing cryptography support for various PKCS applications.

Defines an interface with encrypt / decrypt and
signature signing / verification methods.
Defines an interface with encrypt / decrypt and signature
signing / verification methods.
Currently only OpenSSL backend is supported.

Key and algorithm information is passed in ASN.1 types implemented in
[`sop/crypto-types`](https://packagist.org/packages/sop/crypto-types) package.

## Requirements

- PHP >=7.0
- openssl
- [sop/crypto-types](https://github.com/sop/crypto-types)
- PHP >=7.0
- openssl
- [sop/crypto-types](https://github.com/sop/crypto-types)

## Installation

Expand Down
66 changes: 33 additions & 33 deletions composer.json
@@ -1,35 +1,35 @@
{
"name": "sop/crypto-bridge",
"description": "A PHP library providing cryptography support for various PKCS applications.",
"homepage": "https://github.com/sop/crypto-bridge",
"license": "MIT",
"type": "library",
"keywords": [
"pkcs",
"cryptography",
"encrypt",
"decrypt",
"sign",
"verify"
],
"authors": [
{
"name": "Joni Eskelinen",
"email": "jonieske@gmail.com",
"role": "Developer"
}
],
"require": {
"php": ">=7.0",
"ext-openssl": "*",
"sop/crypto-types": "^0.2.0"
},
"require-dev": {
"phpunit/phpunit": "^6.4"
},
"autoload": {
"psr-4": {
"Sop\\CryptoBridge\\" : "lib/CryptoBridge"
}
}
"name": "sop/crypto-bridge",
"description": "A PHP library providing cryptography support for various PKCS applications.",
"homepage": "https://github.com/sop/crypto-bridge",
"license": "MIT",
"type": "library",
"keywords": [
"pkcs",
"cryptography",
"encrypt",
"decrypt",
"sign",
"verify"
],
"authors": [
{
"name": "Joni Eskelinen",
"email": "jonieske@gmail.com",
"role": "Developer"
}
],
"require": {
"php": ">=7.0",
"ext-openssl": "*",
"sop/crypto-types": "^0.2.0"
},
"require-dev": {
"phpunit/phpunit": "^6.5"
},
"autoload": {
"psr-4": {
"Sop\\CryptoBridge\\": "lib/CryptoBridge"
}
}
}
52 changes: 24 additions & 28 deletions phpunit.xml.dist
@@ -1,30 +1,26 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/4.5/phpunit.xsd"
colors="true"
convertErrorsToExceptions="true"
convertNoticesToExceptions="true"
convertWarningsToExceptions="true"
bootstrap="test/bootstrap.php">
<testsuites>
<testsuite name="Unit">
<directory>test/unit</directory>
</testsuite>
</testsuites>
<filter>
<whitelist
addUncoveredFilesFromWhitelist="true"
processUncoveredFilesFromWhitelist="true">
<directory suffix=".php">lib</directory>
</whitelist>
</filter>
<logging>
<log
type="coverage-clover"
target="build/logs/clover.xml" />
<log
type="coverage-html"
target="build/coverage" />
</logging>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/6.5/phpunit.xsd"
colors="true"
convertErrorsToExceptions="true"
convertNoticesToExceptions="true"
convertWarningsToExceptions="true"
bootstrap="test/bootstrap.php">
<testsuites>
<testsuite name="Unit">
<directory>test/unit</directory>
</testsuite>
</testsuites>
<filter>
<whitelist addUncoveredFilesFromWhitelist="true"
processUncoveredFilesFromWhitelist="true">
<directory suffix=".php">lib</directory>
</whitelist>
</filter>
<logging>
<log type="coverage-clover"
target="build/logs/clover.xml" />
<log type="coverage-html"
target="build/coverage" />
</logging>
</phpunit>

0 comments on commit 433dc87

Please sign in to comment.