open-cas-linux/README.md
Kamil Lepek 641402f2d8 Added readme badges for master CI tests and license
Signed-off-by: Kamil Lepek <kamil.lepek94@gmail.com>
2019-09-10 13:09:48 +02:00

38 lines
2.0 KiB
Markdown

# Open CAS Linux
[![Build Status](https://open-cas-logs.s3.us-east-2.amazonaws.com/master-status/ocl/build/curr-badge.svg)](https://open-cas-logs.s3.us-east-2.amazonaws.com/master-status/ocl/build/build.html)
[![Tests Status](https://open-cas-logs.s3.us-east-2.amazonaws.com/master-status/ocl/tests/curr-badge.svg)](https://open-cas-logs.s3.us-east-2.amazonaws.com/master-status/ocl/tests/tests.html)
[![Coverity status](https://scan.coverity.com/projects/19084/badge.svg)](https://scan.coverity.com/projects/open-cas-open-cas-linux)
[![License](https://open-cas-logs.s3.us-east-2.amazonaws.com/master-status/license-badge.svg)](LICENSE)
Open CAS accelerates Linux applications by caching active (hot) data to
a local flash device inside servers. Open CAS implements caching at the
server level, utilizing local high-performance flash media as the cache drive
media inside the application server as close as possible to the CPU, thus
reducing storage latency as much as possible.
The Open Cache Acceleration Software installs into the GNU/Linux operating
system itself, as a kernel module. The nature of the integration provides a
cache solution that is transparent to users and applications, and your
existing storage infrastructure. No storage migration effort or application
changes are required.
Open CAS is distributed on BSD-3-Clause license (see
https://opensource.org/licenses/BSD-3-Clause for full license texts).
Open CAS uses Safe string library (safeclib) that is MIT licensed.
## Getting Started
To quickly install and deploy Open CAS Linux in your system please follow the instructions
available [here.](https://open-cas.github.io/getting_started_open_cas_linux.html)
## Guide
The complete documentation for Open CAS Linux is available in the Open CAS Linux Administration Guide
available [here.](https://open-cas.github.io/guide_introduction.html)
## Security
To report a potential security vulnerability please follow the instructions
[here.](https://open-cas.github.io/contributing.html#reporting-a-potential-security-vulnerability)