Updated readme and description

Author: weiran

.gitignore

@@ -100,5 +100,5 @@ typings/
 # End of https://www.gitignore.io/api/node,macos,visualstudiocode
 
 # Default input/output files
-squarespace.xml
+input.xml
 blog/

README.md

@@ -1,14 +1,13 @@
-# Blog Migrator from Squarespace XML export to Gatsby
+# Blog Migrator from Wordpress Export to Gatsby
+Migrate your Wordpress blog to Gatsby. This tool takes a Wordpress export, and produces a local folder structure with the content and images.
 
-* Takes two arguments:
-    1. Squarespace XML export file
-    2. Directory to export to
 * Creates folders and files match post structure
-* Exports contents to Markdown for Gatsby
-* Downloads and exports images locally
+* Converts contents to Markdown and stores in a local folder structure
+* Fetches and saves images locally, updating image links in the content
+* Supports link posts with a `passthrough_url`
 
-## To run
+## How to use
 
-Run `npm start INPUTFILE OUTPUTDIR`.
+Run `npm start INPUT_FILE OUTPUT_DIRECTORY`.
 
-Example `npm start squarespace.xml blog`
+Example `npm start input.xml blog`

importer.js

@@ -45,7 +45,7 @@ const importPosts = async (file) => {
         })
         mappedItem.images = images
 
-        // Strip out content tags
+        // Strip out Squarespace content tags
         mappedItem.content = removeSquarespaceCaptions(mappedItem.content)
 
         // Add Markdown conversion

package.json

@@ -1,15 +1,18 @@
 {
-  "name": "squarespace-gatsby-migrate",
+  "name": "wordpress-gatsby-migrate",
   "version": "1.0.0",
-  "description": "",
+  "description": "Migrate your WordPress blog to Gatsby. This tool takes a Wordpress export, and produces a local folder structure with the content and images.",
   "main": "index.js",
   "scripts": {
     "start": "node index.js",
-    "debug": "node --nolazy --inspect-brk=9229 index.js squarespace.xml blog",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "debug": "node --nolazy --inspect-brk=9229 index.js input.xml blog"
   },
-  "author": "",
-  "license": "ISC",
+  "author": "Weiran Zhang",
+  "bugs": {
+    "url": "https://github.com/weiran/wordpress-gatsby-migrate/issues"
+  },
+  "homepage": "https://github.com/weiran/wordpress-gatsby-migrate",
+  "license": "MIT",
   "dependencies": {
     "cheerio": "^1.0.0-rc.2",
     "davefeedread": "^0.4.14",