Skip to content

Commit f1a3c52

Browse files
committed
Updated README
1 parent 85d34f4 commit f1a3c52

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,40 @@
11
# Frontify Finder v2
22

3-
Search and access Frontify assets data from any secure web app.
3+
Authenticate, search and access Frontify assets data from any secure web app.
44

5-
**This package is tightly coupled with the [FrontifyAuthenticator](https://github.com/Frontify/frontify-authenticator) package (@frontify/frontify-authenticator), so you'll have to require both packages in order to make a meaningful use of the Frontify Finder v2.**
5+
**This package is tightly coupled with the [FrontifyAuthenticator](https://github.com/Frontify/frontify-authenticator) package (@frontify/frontify-authenticator) as it's being used as an internal dependency of the Frontify Finder v2.**
66

77
# Install
88

9-
There are three possible ways of installing or requiring the Frontify Authenticator v2 and Frontify Finder v2.
9+
There are three possible ways of installing or requiring the Frontify Finder v2.
1010

1111
## NPM
1212

1313
Installing the latest published package on a third party app is as simple as running `npm i @frontify/frontify-finder` and requiring the main class either via CommonJs or as an ES module.
1414

1515
```
1616
// CommonJs require
17-
const FrontifyAuthenticator = require('@frontify/frontify-authenticator');
1817
const FrontifyFinder = require('@frontify/frontify-finder');
1918
```
2019

2120
**or**
2221

2322
```
2423
// ESM import
25-
import { authorize, refresh, revoke } from '@frontify/frontify-authenticator';
26-
import { open } from '@frontify/frontify-finder';
24+
import { create, logout } from '@frontify/frontify-finder';
2725
```
2826

2927
## CDN
3028

31-
Alternatively, in case you're not relying on npm packages in your web app, you can also require the minified JS script directly by using a CDN such as UPAKG. You can find the latest [Frontify Authenticator v2](https://unpkg.com/@frontify/frontify-authenticator@latest/dist/index.js) and [Frontify Finder v2](https://unpkg.com/@frontify/frontify-finder@latest/dist/index.js) source code and import it to your project you by requiring it via a `<script>` HTML element.
29+
Alternatively, in case you're not relying on npm packages in your web app, you can also require the minified JS script directly by using a CDN such as UPAKG. You can find the latest [Frontify Finder v2](https://unpkg.com/@frontify/frontify-finder@latest/dist/index.js) source code and import it to your project you by requiring it via a `<script>` HTML element.
3230

3331
```
34-
<script src="https://unpkg.com/@frontify/frontify-authenticator@latest/dist/index.js"></script>
3532
<script src="https://unpkg.com/@frontify/frontify-finder@latest/dist/index.js"></script>
3633
```
3734

3835
You may want to require a specific version. To do so you only have to change the word `latest` with the specific version you wish to use (ie. v2.0.0).
3936

40-
To make use of the available methods in the script all you have to do is use the `FrontifyAuthenticator` and `FrontifyFinder` object references attached to the `window`.
37+
To make use of the available methods in the script all you have to do is use the `FrontifyFinder` object references attached to the `window`.
4138

4239
Example:
4340

@@ -53,7 +50,7 @@ window.FrontifyFinder.open(...);
5350

5451
## LOCAL
5552

56-
To install any package locally doesn't differ greatly from the CDN use case. You can use the links mentioned above [here](https://unpkg.com/@frontify/frontify-authenticator@latest/dist/index.js) and [here](https://unpkg.com/@frontify/frontify-finder@latest/dist/index.js) to download the files contents, save it to your local instance and require via `<script>` HTML element making the `src` address point to your local file.
53+
To install any package locally doesn't differ greatly from the CDN use case. You can use the link mentioned above [here](https://unpkg.com/@frontify/frontify-finder@latest/dist/index.js) to download the files contents, save it to your local instance and require via `<script>` HTML element making the `src` address point to your local file.
5754

5855
```
5956
<script src="<PATH_TO_FILE>/<FILENAME>.js"></script>

0 commit comments

Comments
 (0)