Contents

# Copyleaks Ruby SDK

Copyleaks SDK is a simple framework that allows you to scan text for plagiarism and detect content distribution online, using the Copyleaks plagiarism checker cloud.

Using Copyleaks SDK you can check for plagiarism in:
* Online content and webpages
* Local and cloud files (see [supported files](https://api.copyleaks.com/documentation/specifications#2-supported-file-types))
* Free text
* OCR (Optical Character Recognition) - scanning pictures with textual content (see [supported files](https://api.copyleaks.com/documentation/specifications#6-supported-image-types-ocr))

## Installation

Install using [RubyGems](https://rubygems.org/gems/plagiarism-checker)

```bash
gem install plagiarism-checker
```

## Register and Get Your API Key
To use the Copyleaks API you need to first be a registered user. The registration to Copyleaks takes a minute and is free of charge. [Signup](https://api.copyleaks.com/?register=true) and make sure to confirm your account.

As a signed user you can generate your personal API key. Do so on your [dashboard home](https://api.copyleaks.com/dashboard/:product) under 'API Access Credentials'.

For more information check out our [API guide](https://api.copyleaks.com/documentation/v3).

## Usage
```rb
require 'copyleaks'
copyleaks = Copyleaks::API.new
res = copyleaks.login(<your email>,<your api key>)
puts res.to_json
```

## Demo
See [demo.rb](./demo/demo.rb) under demo folder for an example.
## Read More
* [API Homepage](https://api.copyleaks.com/)
* [API Documentation](https://api.copyleaks.com/documentation)
* [Plagiarism Report](https://github.com/Copyleaks/plagiarism-report)

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
plagiarism-checker-3.0.3	README.md
plagiarism-checker-3.0.2	README.md
plagiarism-checker-3.0.1	README.md
plagiarism-checker-3.0.0	README.md