Rename project: carpe-medium -> Seance
New name suggested by @manasakashi12, since that's what a seance does: relay messages between Ghost and Medium ;-)
This commit is contained in:
parent
770dbb0850
commit
7f2cbcc221
2 changed files with 12 additions and 12 deletions
18
README.md
18
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!
|
> **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:
|
To install, run the following commands:
|
||||||
|
|
||||||
cd carpe-medium
|
cd seance
|
||||||
yarn install
|
yarn install
|
||||||
yarn link
|
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.
|
check permissions or run `node ./index.js` directly.
|
||||||
|
|
||||||
# usage
|
# usage
|
||||||
|
@ -31,25 +31,25 @@ welcome!
|
||||||
## Pull a post from Medium
|
## Pull a post from Medium
|
||||||
|
|
||||||
# replace the URL with an actual Medium post
|
# 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:
|
This will create a new folder in `./content` containing:
|
||||||
|
|
||||||
* the post as a markdown file
|
* the post as a markdown file
|
||||||
* image files for each post (linked appropriately)
|
* 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
|
## Push a post to Ghost
|
||||||
|
|
||||||
# replace some-post with post directory
|
# 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!
|
Currently, this command does not do anything. We're working on it!
|
||||||
|
|
||||||
## Copy a Medium post directly to Ghost
|
## Copy a Medium post directly to Ghost
|
||||||
|
|
||||||
# replace the URL with an actual Medium post
|
# 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`
|
This is basically the other two commands combined, so, like the `push`
|
||||||
command, doesn't do anything for the second part as of now.
|
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
|
# Replace username and email with appropriate values
|
||||||
# The username should match an existing Medium user
|
# 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
|
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
|
(eg. `ghost-import.json`), then open your Ghost Admin and import the
|
||||||
|
|
|
@ -1,15 +1,15 @@
|
||||||
{
|
{
|
||||||
"name": "carpe-medium",
|
"name": "seance",
|
||||||
"version": "1.0.0-dev",
|
"version": "1.0.0-dev",
|
||||||
"description": "pull posts from Medium.com and add them to a Ghost blog",
|
"description": "pull posts from Medium.com and add them to a Ghost blog",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
"repository": "https://gitlab.com/snipettemag.com/carpe-medium",
|
"repository": "https://gitlab.com/snipettemag.com/seance",
|
||||||
"author": "Badri Sunderarajan <badrihippo@gmail.com>",
|
"author": "Badri Sunderarajan <badrihippo@gmail.com>",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"private": false,
|
"private": false,
|
||||||
"preferGlobal": true,
|
"preferGlobal": true,
|
||||||
"bin": {
|
"bin": {
|
||||||
"carpe-medium": "index.js"
|
"seance": "index.js"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"commander": "^3.0.2",
|
"commander": "^3.0.2",
|
||||||
|
|
Loading…
Reference in a new issue