From 7e1be664d69bb9893c2632528a69dadd6c2185c8 Mon Sep 17 00:00:00 2001 From: Brad Rogers Date: Fri, 16 Oct 2020 17:11:45 -0700 Subject: [PATCH] Update README, update package.json with repo info (#7) --- README.md | 22 ++++++++++++++++------ package.json | 32 ++++++++++++++++++++++++++------ 2 files changed, 42 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 84a6de7..c94e3e5 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -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 ``` - -``` \ No newline at end of file + +``` + +## 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 \ No newline at end of file diff --git a/package.json b/package.json index 16fd5a4..941cc80 100644 --- a/package.json +++ b/package.json @@ -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 ", + "license": "MIT", "main": "src/dropboxPopup.js", "browser": "dist/dropboxPopup.js", "scripts": { @@ -12,8 +14,6 @@ "lint": "eslint *.js .", "lint-fix": "eslint *.js . --fix" }, - "author": "Brad Rogers ", - "license": "MIT", "devDependencies": { "@babel/core": "^7.12.0", "@babel/preset-env": "^7.12.0", @@ -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" + ] +} \ No newline at end of file