Skip to content

Commit

Permalink
Update README, update package.json with repo info (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
rogebrd authored Oct 17, 2020
1 parent deab46d commit 7e1be66
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 12 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# Dropbox OAuth Popup Window
[![Logo][logo]][repo]

[![npm](https://img.shields.io/npm/v/dropbox-oauth-popup)](https://www.npmjs.com/package/dropbox-oauth-popup)

This is a simple addition built onto the [Dropbox SDK](https://github.com/dropbox/dropbox-sdk-js) that allows for OAuth in the browser to be done via a popup window.
This is a simple addition built onto the [Dropbox SDK][sdk] that allows for OAuth in the browser to be done via a popup window.

# Usage
## Usage

1. Create a new instance of the `DropboxPopup` class

Expand All @@ -23,7 +24,7 @@ popup.authUser((auth) => {
}
```

# Distributions
## Distributions

If you are using this via a node project compiled into browser assets, you can install via npm

Expand All @@ -34,5 +35,14 @@ npm install --save-dev dropbox-oauth-popup
Or you can use it directly in your browser be including the following tag

```
<script src="https://cdn.jsdelivr.net/npm/dropbox-oauth-popup@1.0.0"></script>
```
<script src="https://cdn.jsdelivr.net/npm/dropbox-oauth-popup@1.2.0"></script>
```

## License

This package is distributed under the MIT license, please see [LICENSE][license] for more information.

[logo]: https://repository-images.githubusercontent.com/304185097/6579e180-0fd1-11eb-9d46-91db905a363a
[repo]: https://github.com/rogebrd/dropbox-oauth-popup
[sdk]: https://github.com/dropbox/dropbox-sdk-js
[license]: https://github.com/rogebrd/dropbox-oauth-popup/blob/main/LICENSE
32 changes: 26 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
{
"name": "dropbox-oauth-popup",
"version": "1.1.0",
"version": "1.2.0",
"registry": "npm",
"description": "This is a simple addition built onto the Dropbox SDK that allows for OAuth in the browser to be done via a popup window.",
"homepage": "https://github.com/rogebrd/dropbox-oauth-popup",
"author": "Brad Rogers <brad12rogers@gmail.com>",
"license": "MIT",
"main": "src/dropboxPopup.js",
"browser": "dist/dropboxPopup.js",
"scripts": {
Expand All @@ -12,8 +14,6 @@
"lint": "eslint *.js .",
"lint-fix": "eslint *.js . --fix"
},
"author": "Brad Rogers <brad12rogers@gmail.com>",
"license": "MIT",
"devDependencies": {
"@babel/core": "^7.12.0",
"@babel/preset-env": "^7.12.0",
Expand All @@ -28,11 +28,31 @@
"dependencies": {
"dropbox": "^7.1.0"
},
"browserslist": [
"> 0.25%",
"not dead"
],
"files": [
"*.md",
"LICENSE",
"src",
"test",
"dist"
],
"repository": {
"type": "git",
"url": "git+https://github.com/rogebrd/dropbox-oauth-popup.git"
"url": "https://github.com/rogebrd/dropbox-oauth-popup.git"
},
"bugs": {
"url": "https://github.com/rogebrd/dropbox-oauth-popup/issues"
}
}
},
"keywords": [
"dropbox",
"auth",
"oauth",
"popup",
"browser",
"front-end",
"window"
]
}

0 comments on commit 7e1be66

Please sign in to comment.