Merge pull request #2 from PreviewLinks/development

Merge Development

Author: CraftLogan

.github/SECURITY.md

@@ -1,3 +1,3 @@
 # Security Policy
 
-If you discover any security related issues, please email [email protected] instead of using the issue tracker.
+If you discover any security related issues, please email [email protected] instead of using the issue tracker.

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) Flowframe <[email protected]>
+Copyright (c) PreviewLinks <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,56 +1,56 @@
-# Previewify for Node.js
+# PreviewLinks for Node.js
 
-This is the official [Previewify](https://previewify.app) client for Node.js.
+This is the official [PreviewLinks](https://previewlinks.io) client for Node.js.
 
 ## Installation
 
 You can install the package via NPM:
 
 ```bash
-npm install @flowframe/node-previewify
+npm install @previewlinks/node-previewlinks
 ```
 
 ## Usage
 
 ### Creating an instance
 
 ```js
-const { Previewify } = require('@flowframe/node-previewify')
+const { PreviewLinks } = require('@previewlinks/node-previewlinks')
 
-const previewify = new Previewify({ apiToken: '<YOUR_API_TOKEN>' })
+const previewlinks = new PreviewLinks({ apiToken: '<YOUR_API_TOKEN>' })
 ```
 
 ### Methods
 
 ```js
 // List sites
-previewify
+previewlinks
     .listSites()
     .then(response => response.data)
 
 // Show site
 let siteId = 1
 
-previewify
+previewlinks
     .showSite(siteId)
     .then(response => response.data)
 
 // Show site's templates
 let siteId = 1
 
-previewify
+previewlinks
     .listSiteTemplates(siteId)
     .then(response => response.data)
 
 // Generate a direct image URL (useful for downloading and storing images yourself)
 let siteId = 1
 let templateId = 1
 let fields = {
-    'previewify:title': 'Hello from Node.js!',
-    'previewify:subtitle': 'This is an example...',
+    'previewlinks:title': 'Hello from Node.js!',
+    'previewlinks:subtitle': 'This is an example...',
 }
 
-previewify
+previewlinks
     .downloadImage({
         siteId,
         templateId,
@@ -65,6 +65,7 @@ Please review [our security policy](../../security/policy) on how to report secu
 
 ## Credits
 
+-   [Logan Craft](https://github.com/CraftLogan)
 -   [Lars Klopstra](https://github.com/flowframe)
 -   [All Contributors](../../contributors)
 

package-lock.json

@@ -1,15 +1,16 @@
 {
-    "name": "@flowframe/node-previewify",
-    "description": "The official Previewify node.js SDK",
+    "name": "@previewlinks/node-previewlinks",
+    "description": "The official PreviewLinks node.js SDK",
     "main": "src/index.js",
     "version": "0.1.0",
     "scripts": {
         "prettier": "npx prettier --write ./src"
     },
     "keywords": [
+        "previewlinks",
         "previewify"
     ],
-    "author": "Lars Klopstra",
+    "author": "Logan Craft",
     "license": "MIT",
     "dependencies": {
         "axios": "^0.25.0"

package.json

@@ -1,10 +1,10 @@
 const axios = require('axios')
 const crypto = require('crypto')
 
-class Previewify {
-    #API_BASE_URL = 'https://previewify.app/api/v1'
+class PreviewLinks {
+    #API_BASE_URL = 'https://previewlinks.io/api/v1'
 
-    #GENERATE_BASE_URL = 'https://previewify.app/generate'
+    #GENERATE_BASE_URL = 'https://previewlinks.io/generate'
 
     constructor({ apiToken }) {
         this.apiToken = apiToken
@@ -51,5 +51,5 @@ class Previewify {
 }
 
 module.exports = {
-    Previewify,
+    PreviewLinks,
 }