Skip to content

Commit

Permalink
fork instructions & scope this pkg
Browse files Browse the repository at this point in the history
  • Loading branch information
wescpy committed Aug 25, 2023
1 parent 8b90582 commit 777495d
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 19 deletions.
19 changes: 6 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,14 @@
Generate Google Slides from markdown & HTML. Run from the command line or embed in another
application.
Generate Google Slides from markdown & HTML. Run from the command line or embed in another application. This project was developed as an example of how to use the [Google Slides (REST) API](https://developers.google.com/slides). While it does not yet produce stunningly beautiful decks, you are encouraged to use this tool for quickly prototyping presentations. Contributions are welcome.

This project was developed as an example of how to use the
[Slides API](https://developers.google.com/slides).
**NOTE**: This is a fork of the original repo at <https://github.com/googleworkspace/md2googleslides>. The project is still "actively" maintained, but some users can't wait for the PRs from the original maintainer. Upstream changes will be merged as necessary.

While it does not yet produce stunningly beautiful decks, you are encouraged to use
this tool for quickly prototyping presentations.

Contributions are welcome.

## Installation and usage

For command line use, install md2gslides globally:
For command line use, install `md2gslides` globally:

```sh
npm install -g md2gslides
npm install -g @wescpy/md2gslides
```

Then get your OAuth client ID credentials:
Expand All @@ -33,7 +27,7 @@ After installing, import your slides by running:
md2gslides slides.md --title "Talk Title"
```

This will generate new Google Slides in your account with title `Talk Title`.
This will generate new Google Slides in your account with title `Talk Title`.

NOTE: The first time the command is run you will be prompted for authorization. OAuth token
credentials are stored locally in a file named `~/.md2googleslides/credentials.json`.
Expand Down Expand Up @@ -440,5 +434,4 @@ See [CONTRIBUTING](CONTRIBUTING.md) for additional terms.

## License

This library is licensed under Apache 2.0. Full license text is
available in [LICENSE](LICENSE).
This library is licensed under Apache 2.0. Full license text is available in [LICENSE](LICENSE).
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"name": "md2gslides",
"name": "@wescpy/md2gslides",
"engines": {
"node": ">=12.0.0"
},
"version": "0.5.1",
"version": "0.6",
"description": "Convert Markdown to Google Slides",
"main": "index.js",
"files": [
Expand Down
5 changes: 5 additions & 0 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2880,6 +2880,11 @@ fs.realpath@^1.0.0:
resolved "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz"
integrity sha1-FQStJSMVjKpA20onh8sBQRmU6k8=

fsevents@~2.3.1:
version "2.3.2"
resolved "https://registry.npmjs.org/fsevents/-/fsevents-2.3.2.tgz"
integrity sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==

function-bind@^1.1.1:
version "1.1.1"
resolved "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz"
Expand Down

0 comments on commit 777495d

Please sign in to comment.