Skip to content

Commit a2c63e1

Browse files
committed
Updated README.md and workflow
1 parent 70d492f commit a2c63e1

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

.github/workflows/publish.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ jobs:
2424
run: |
2525
npm i && npm run build
2626
mkdir ${{ env.PLUGIN_NAME }}
27-
cp README.md package.json icon.png ${{ env.PLUGIN_NAME }}
27+
cp README.md package.json icon.png logseq-github.gif ${{ env.PLUGIN_NAME }}
2828
mv dist ${{ env.PLUGIN_NAME }}
2929
zip -r ${{ env.PLUGIN_NAME }}.zip ${{ env.PLUGIN_NAME }}
3030
ls

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ This example shows how to embed a file from a repository which is synced to Gith
3636
3. Open Logseq and select `Add a graph` from the left sidebar graph menu item.
3737
4. Navigate to the docs `folder` that you have just created.
3838
5. Use Logseq to document your development process.
39-
6. When you are ready to document specific code in the repository, follow the per-file to embed process described below.
39+
6. When you are ready to document specific code in the repository, follow the `Running the Github Command` process described below.
4040

4141
## Running the Github Command
4242

@@ -54,10 +54,10 @@ This example shows how to embed a file from a repository which is synced to Gith
5454

5555
Step 4 should be amended as follows:
5656

57-
1. If the file is not in the default repository, enter the name of repository, followed by a double-colon '::', before the relative path. e.g. `another-repo:src/package-json`
58-
2. If the file is not in the default account nor the default repository, enter the name of the account, followed by '?', the name of the repository, followed by a colon ':', before the relative path. `another-account::yet-another-repo:src/package.json`
57+
1. If the file is not in the default repository, enter the name of repository, followed by a colon ':', before the relative path. e.g. `another-repo:src/package-json`
58+
2. If the file is not in the default account nor the default repository, enter the name of the account, followed by a double-colon '::', the name of the repository, followed by a colon ':', before the relative path. `another-account::yet-another-repo:src/package.json`
5959

60-
The general URL format is `<account name>::<repository name>?<relative filepath>`
60+
The general URL format is `<account name>::<repository name>:<relative filepath>`
6161

6262
## Refreshing the code
6363

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "logseq-plugin-github-get",
3-
"version": "1.0.0",
3+
"version": "1.0.1",
44
"description": "Get a file from a github repo",
55
"main": "dist/index.html",
66
"targets": {

0 commit comments

Comments
 (0)