Comparing version 0.0.22 to 1.0.0
@@ -25,3 +25,3 @@ (function (root, factory) { | ||
var SOURCE = 'library'; | ||
var VERSION = '0.0.22'; | ||
var VERSION = '1.0.0'; | ||
@@ -72,3 +72,3 @@ function Optiic(options) { | ||
if (!nodeFetch) { | ||
nodeFetch = This.options.environment === 'browser' ? window.fetch : require('node-fetch'); | ||
nodeFetch = This.options.environment === 'browser' ? window.fetch : require('wonderful-fetch'); | ||
} | ||
@@ -75,0 +75,0 @@ |
{ | ||
"name": "optiic", | ||
"version": "0.0.22", | ||
"version": "1.0.0", | ||
"description": "An advanced free OCR & image recognition API.", | ||
@@ -8,3 +8,3 @@ "main": "./dist/index.js", | ||
"test": "npm run prepare && ./node_modules/mocha/bin/mocha test/ --recursive --timeout=10000", | ||
"prepare": "node -e 'require(`prepare-package`)()'", | ||
"prepare": "node -e \"require('prepare-package')()\"", | ||
"prepare:watch": "nodemon -w ./src -e '*' --exec 'npm run prepare'" | ||
@@ -39,7 +39,8 @@ }, | ||
"form-data": "^3.0.1", | ||
"node-fetch": "^2.6.7" | ||
"itwcw-package-analytics": "^1.0.3", | ||
"wonderful-fetch": "^1.1.11" | ||
}, | ||
"devDependencies": { | ||
"mocha": "^8.4.0", | ||
"prepare-package": "^1.1.3" | ||
"prepare-package": "^1.1.11" | ||
}, | ||
@@ -46,0 +47,0 @@ "preparePackage": { |
<p align="center"> | ||
<a href="https://cdn.itwcreativeworks.com/assets/optiic/images/logo/optiic-brandmark-black-x.svg"> | ||
<a href="https://optiic.dev"> | ||
<img src="https://cdn.itwcreativeworks.com/assets/optiic/images/logo/optiic-brandmark-black-x.svg" width="100px"> | ||
@@ -28,6 +28,6 @@ </a> | ||
## Optiic Works in Node AND browser environments | ||
## 🌐 Optiic Works in Node AND browser environments | ||
Yes, this module works in both Node and browser environments, including compatibility with [Webpack](https://www.npmjs.com/package/webpack) and [Browserify](https://www.npmjs.com/package/browserify)! | ||
## Features | ||
## 🦄 Features | ||
* Image recognition and analysis API | ||
@@ -40,7 +40,7 @@ * Provide images as URLs or upload them directly | ||
### Getting an API key | ||
### 🔑 Getting an API key | ||
You can use so much of `optiic` for free, but if you want to do some advanced stuff, you'll need an API key. You can get one by [signing up for an account](https://optiic.dev/signup). | ||
## Install Optiic | ||
### Install via npm | ||
## 📦 Install Optiic | ||
### Option 1: Install via npm | ||
Install with npm if you plan to use `optiic` in a Node project or in the browser. | ||
@@ -58,3 +58,3 @@ ```shell | ||
### Install via CDN | ||
### Option 2: Install via CDN | ||
Install with CDN if you plan to use Optiic only in a browser environment. | ||
@@ -70,10 +70,10 @@ ```html | ||
### Use without installation | ||
### Option 3: Use without installation | ||
You can use `optiic` in a variety of ways that require no installation, such as `curl` in terminal/shell. See the **Use without installation** section below. | ||
## Example output | ||
## 📝 Example output | ||
If you want to see how `optiic` works, you can try a sample such as [this image](https://optiic.dev/assets/images/samples/we-love-optiic.png): | ||
<p align="center"> | ||
<a href="https://optiic.dev/assets/images/samples/we-love-optiic.png"> | ||
<a href="https://optiic.dev"> | ||
<img src="https://optiic.dev/assets/images/samples/we-love-optiic.png" width="100%"> | ||
@@ -93,3 +93,3 @@ </a> | ||
## Using Optiic | ||
## ⚡️ Using Optiic | ||
After you have followed the install step, you can start using `optiic` to analyze images and perform OCR from within your app! | ||
@@ -157,6 +157,3 @@ | ||
## Extending Capabilities | ||
For a more in-depth documentation of this library and the Optiic service, please visit the official Optiic website. | ||
## Use without installation | ||
## 🔧 Use without installation | ||
### Use Optiic with `curl` | ||
@@ -180,10 +177,12 @@ #### OCR with URL | ||
## What Can Optiic do? | ||
## 📝 What Can Optiic do? | ||
[Optiic is a free OCR api](https://optiic.dev) that helps you analyze images and perform OCR (optical character recognition)! | ||
## Final Words | ||
For a more in-depth documentation of this library and the Optiic service, please visit the official Optiic website. | ||
## 🗨️ Final Words | ||
If you are still having difficulty, we would love for you to post | ||
a question to [the Optiic issues page](https://github.com/optiic/optiic/issues). It is much easier to answer questions that include your code and relevant files! So if you can provide them, we'd be extremely grateful (and more likely to help you find the answer!) | ||
## Projects Using this Library | ||
## 📚 Projects Using this Library | ||
[Somiibo](https://somiibo.com/): A Social Media Bot with an open-source module library. <br> | ||
@@ -190,0 +189,0 @@ [JekyllUp](https://jekyllup.com/): A website devoted to sharing the best Jekyll themes. <br> |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
16042
0
3
188
+ Addedwonderful-fetch@^1.1.11
+ Addedbalanced-match@1.0.2(transitive)
+ Addedbrace-expansion@1.1.11(transitive)
+ Addedconcat-map@0.0.1(transitive)
+ Addedfs-jetpack@4.3.1(transitive)
+ Addedfs.realpath@1.0.0(transitive)
+ Addedglob@7.2.3(transitive)
+ Addedinflight@1.0.6(transitive)
+ Addedinherits@2.0.4(transitive)
+ Addeditwcw-package-analytics@1.0.6(transitive)
+ Addedjson5@2.2.3(transitive)
+ Addedminimatch@3.1.2(transitive)
+ Addedonce@1.4.0(transitive)
+ Addedpath-is-absolute@1.0.1(transitive)
+ Addedrimraf@2.7.1(transitive)
+ Addeduuid@9.0.1(transitive)
+ Addedwonderful-fetch@1.2.2(transitive)
+ Addedwrappy@1.0.2(transitive)
- Removednode-fetch@^2.6.7