diff --git a/README.md b/README.md index 6b60396..8eccdfe 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# carpe-medium +# Seance -fetch Medium posts and push them to Ghost +relay content from Medium to Ghost [WIP] > **Note:** This app is still work in progress! @@ -10,11 +10,11 @@ fetch Medium posts and push them to Ghost To install, run the following commands: - cd carpe-medium + cd seance yarn install yarn link -The `carpe-medium` command should now be available in your path. If not, +The `seance` command should now be available in your path. If not, check permissions or run `node ./index.js` directly. # usage @@ -31,25 +31,25 @@ welcome! ## Pull a post from Medium # replace the URL with an actual Medium post - carpe-medium fetch https://medium.com/@username/some-post-abc123 + seance fetch https://medium.com/@username/some-post-abc123 This will create a new folder in `./content` containing: * the post as a markdown file * image files for each post (linked appropriately) -* [upcoming] a JSON file with post metadata +* a JSON file with post metadata ## Push a post to Ghost # replace some-post with post directory - carpe-medium push content/some-post + seance push content/some-post Currently, this command does not do anything. We're working on it! ## Copy a Medium post directly to Ghost # replace the URL with an actual Medium post - carpe-medium import https://medium.com/@username/some-post-abc123 + seance import https://medium.com/@username/some-post-abc123 This is basically the other two commands combined, so, like the `push` command, doesn't do anything for the second part as of now. @@ -58,7 +58,7 @@ command, doesn't do anything for the second part as of now. # Replace username and email with appropriate values # The username should match an existing Medium user - carpe-medium content username user@example.com + seance content username user@example.com This will output a JSON object. Copy-paste that object into a new file (eg. `ghost-import.json`), then open your Ghost Admin and import the diff --git a/package.json b/package.json index 39c0ecb..143d259 100644 --- a/package.json +++ b/package.json @@ -1,15 +1,15 @@ { - "name": "carpe-medium", + "name": "seance", "version": "1.0.0-dev", "description": "pull posts from Medium.com and add them to a Ghost blog", "main": "index.js", - "repository": "https://gitlab.com/snipettemag.com/carpe-medium", + "repository": "https://gitlab.com/snipettemag.com/seance", "author": "Badri Sunderarajan ", "license": "MIT", "private": false, "preferGlobal": true, "bin": { - "carpe-medium": "index.js" + "seance": "index.js" }, "dependencies": { "commander": "^3.0.2",