notion_to_md 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df84120caddccce07f99e140867a59ca176ee9c639a019785ef74faea03de32b
-  data.tar.gz: 5d95ff8014362018d505944b3b1afaf6593fac9f3f90cab28f6abd645843b39f
+  metadata.gz: e6f3d20369829f0cf5f2245eec32fcfc98a01b12edbf143451234922421ba2e1
+  data.tar.gz: eb3465f0295b9514fcf120efc1330d432d378c449ac5e1e279b19f0e6b8801f4
 SHA512:
-  metadata.gz: 24a41732b091218c1c3b9b428714419a9ce993669d5edde0baa011cfb6953cb4db433aa8dc4536670577062b7a304b4d686361b756580800afcb72ebe2ab95b1
-  data.tar.gz: c2a9e707c602366f8f9e5d811c7010a65cdcf7c0a6fff17353b3a04a5cc28db7be452e453c5ee218b24a007c1c5d753aefb44c443c77e16cec1028097fcc71bf
+  metadata.gz: 927753e91887ac4d10b6a325f77f862e55676c607936c2b7a193eb6a5dd9bddf8dcc5824c7d02e714c90037a119921d114cec116e8989d1c789ff63993a2791d
+  data.tar.gz: b3a457117754849fff34035373385811260c0bf25093208747f3dda6800a0107acf7d1ae46328bb25583428975e8155960f03cb84a53f070afc4bd15d7836949

data/README.md

@@ -1,2 +1,41 @@
 # notion_to_md
-Notion Markdown Exporter in Ruby
+Notion Markdown Exporter in Ruby.
+
+## Installation
+Use gem to install.
+```bash
+$ gem install 'notion_to_md'
+```
+
+Or add it to the `Gemfile`.
+```ruby
+# Gemfile
+gem 'notion_to_md'
+```
+
+## Usage
+Before using the gem create an integration and generate a secret token. Check [notion getting started guide](https://developers.notion.com/docs/getting-started) to learn more.
+
+Pass the page id and secret token to the constructor and execute the `convert` method.
+
+```ruby
+require 'notion_to_md'
+
+notion_converter = NotionToMd::Converter.new(page_id: 'b91d5...', token: 'secret_...')
+md = notion_converter.convert
+```
+
+If the secret token is provided as an environment variable —`NOTION_TOKEN`—, there's no need to pass it as an argument to the constructor.
+
+```bash
+$ export NOTION_TOKEN=<secret_...>
+```
+
+```ruby
+require 'notion_to_md'
+
+notion_converter = NotionToMd::Converter.new(page_id: 'b91d5...')
+md = notion_converter.convert
+```
+
+And that's all. The `md` is a string variable containing the notion page formatted in markdown.

data/lib/notion_to_md/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NotionToMd
-  VERSION = '0.0.0'
+  VERSION = '0.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notion_to_md
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Enrique Arias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-28 00:00:00.000000000 Z
+date: 2021-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: notion-ruby-client
@@ -48,7 +48,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.3
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="