figma-development-kit - npm Package Compare versions

Comparing version 1.0.6 to 1.0.8

package.json

 {
   "name": "figma-development-kit",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "A set of tools that augment the Figma API",
+  "main": "index.js",
   "repository": {
@@ -6,0 +7,0 @@ "type": "git",

README.md

 ## OAuth2
 [demo](https://chuanqisun.github.io/figma-development-kit/demo/auth-demo.html) | [src](https://github.com/chuanqisun/figma-development-kit/blob/master/demo/auth-demo.html)
+
+### Quick start
+Download [`callback.html`](https://raw.githubusercontent.com/chuanqisun/figma-development-kit/master/dist/callback.html) and add it to your project. Make sure you add the url of the callback file to your [Figma developer settings page](https://www.figma.com/developers/apps). Learn more by reading the  [Figma OAuth2 setup guide](https://www.figma.com/developers/docs#auth-oauth).
+
+Directly use in browser
+```html
+<script src="https://unpkg.com/figma-development-kit@^1/dist/fdk.umd.js"></script>
+```
+```js
+const fiamgaApi = new fdk.FigmaApi({
+  clientId: '<FIGMA_CLIENT_ID>',
+  clientSecrete: '<FIGMA_CLIENT_SECRETE>',
+  /* e.g. http://localhost:5000/callback.html or https://www.my-awesome-project.com/callback.html */
+  redirectUri: '<PATH_TO_CALLBACK_FILE>', 
+});
+
+fiamgaApi.getOAuth2Token().then(token => {
+  console.log(token);
+});
+```
+
+Import as an ES6 module
+```js
+/* in source code */
+npm install --save figma-development-kit
+```
+
+```js
+import { FigmaApi } from 'figma-development-kit';
+
+const fiamgaApi = new FigmaApi({
+  clientId: '<FIGMA_CLIENT_ID>',
+  clientSecrete: '<FIGMA_CLIENT_SECRETE>',
+  redirectUri: '<PATH_TO_CALLBACK_FILE>',
+});
+
+fiamgaApi.getOAuth2Token().then(token => {
+  console.log(token);
+});
+```
+
+

No alert changes

Improved metrics

Total package byte prevSize

14355

increased by9.76%

Number of package files

10

increased by11.11%

Number of lines in readme file

45

increased by1400%

No dependency changes