add release workflow and update readme

.github/workflows/releases.yml

@@ -0,0 +1,72 @@
+name: Build obsidian plugin
+
+on:
+  push:
+    tags:
+    - '*'
+
+env:
+  PLUGIN_NAME: obsidian-tweet-to-markdown
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js
+      uses: actions/setup-node@v1
+      with:
+        node-version: '14.x'
+    - name: Build
+      id: build
+      run: |
+        npm install
+        npm run build --if-present
+        mkdir ${{ env.PLUGIN_NAME }}
+        cp main.js manifest.json ${{ env.PLUGIN_NAME }}
+        zip -r ${{ env.PLUGIN_NAME }}.zip ${{ env.PLUGIN_NAME }}
+        ls
+        echo "::set-output name=tag_name::$(git tag --sort version:refname | tail -n 1)"
+    - name: Create Release
+      id: create_release
+      uses: actions/create-release@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        VERSION: ${{ github.ref }}
+      with:
+        tag_name: ${{ github.ref }}
+        release_name: ${{ github.ref }}
+        draft: false
+        prerelease: false
+    - name: Upload zip file
+      id: upload-zip
+      uses: actions/upload-release-asset@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        upload_url: ${{ steps.create_release.outputs.upload_url }}
+        asset_path: ./${{ env.PLUGIN_NAME }}.zip
+        asset_name: ${{ env.PLUGIN_NAME }}-${{ steps.build.outputs.tag_name }}.zip
+        asset_content_type: application/zip
+    - name: Upload main.js
+      id: upload-main
+      uses: actions/upload-release-asset@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        upload_url: ${{ steps.create_release.outputs.upload_url }}
+        asset_path: ./main.js
+        asset_name: main.js
+        asset_content_type: text/javascript
+    - name: Upload manifest.json
+      id: upload-manifest
+      uses: actions/upload-release-asset@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        upload_url: ${{ steps.create_release.outputs.upload_url }}
+        asset_path: ./manifest.json
+        asset_name: manifest.json
+        asset_content_type: application/json

README.md

@@ -35,13 +35,23 @@ Or, if you'd like to install it manually, clone this repository to the `.obsidia
 ### Bearer token
 To use this tool, you'll need to set up an application and get a bearer token on the [Twitter developer dashboard](https://developer.twitter.com/en/portal/dashboard). Once you have the bearer token, you can paste it into the bearer token field on the Tweet to Markdown settings page. If you'd rather protect the token a bit more, you can store it in the environment variable `TWITTER_BEARER_TOKEN`.
 
+Nota bene: On Unix machines, make sure to set this in your profile file (such as `~/.bash_profile`) so that it will be available to Obsidian.
+
 ### Downloading a tweet
 
 Either click the Twitter logo in your sidebar or run the command `Download Tweet from URL` from the command palette. Then, just paste in the link to a tweet and click download.
 
+To download a tweet thread, see [Downloading a tweet thread](###Thread)
+
+![The modal to download a new tweet.](images/download_tweet_modal.png)
+
+Once the tweet is downloaded, you'll be presented a window to set the name of the file that will be created. You can use the variables `[[handle]]`, `[[name]]`, and `[[id]]` when naming your file, which will be automatically replaced with the author's handle, name, and the tweet ID.
+
+![The modal to name a downloaded tweet.](images/tweet_complete_modal.png)
+
 The tweet will be saved to a Markdown file in the root of your vault, or in the directory specified in your settings. Here's how the tweet will look:
 
-![Screenshot of the rendered Markdown file](images/markdown_screenshot.png)
+![The rendered Markdown file](images/markdown_screenshot.png)
 
 Any attached images, polls, and links will also be linked and displayed in the file.
 
@@ -51,7 +61,7 @@ On the Tweet to Markdown settings page in Obsidian, you can customize the way th
 
 ### Custom File Name
 
-Tweets are usually saved with the filename `[[handle]] - [[id]].md`. You can instead enter your own format in the **Filename** field using the variables `[[name]]`, `[[handle]]`, and `[[id]]` in your filename, which will automatically be replaced. The file extension `.md` will also be added.
+Tweets are, by default, saved with the filename `[[handle]] - [[id]].md`. You can instead enter your own format in the **Filename** field using the variables `[[name]]`, `[[handle]]`, and `[[id]]` in your filename, which will automatically be replaced. The file extension `.md` will also be added.
 
 ### Custom File Path
 
@@ -63,7 +73,7 @@ Want to really capture the entire tweet locally? You can flip the **Download ima
 
 Tweet images will be automatically saved to the directory `tweet-assets/`. If you'd like to save the assets to a custom directory, type that directory in the **Image location** field.
 
-Nota bene: Unfortunately, there is currently not a way to save gifs or videos from tweets using the v2 API.
+Nota bene: Unfortunately, there is currently not a way to retrieve gifs or videos from tweets using the v2 API.
 
 <!-- CONTRIBUTING -->