Skip to content

Commit 45f526d

Browse files
committed
Remove branch refs from install instructions
1 parent 19371ca commit 45f526d

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ You'll need to install two things to run Sverto:
1616
Install the project extension using:
1717

1818
```
19-
quarto use template 360-info/sverto@firstrelease-docs
19+
quarto use template 360-info/sverto
2020
```
2121

2222
Then run:
@@ -41,7 +41,7 @@ Here's the short way to add Svelte component you've written to a Quarto doc:
4141
:::
4242
```
4343
44-
2. Import your Svelte component with `Component = import_svelte("Component.svelte")`
44+
2. Import your Svelte component in OJS with `Component = import_svelte("Component.svelte")`
4545
3. Add a target block for your visual using `:::` and give it an `#id`
4646
4. Instantiate the Svelte component with `myVisual = Component.default()` using some default props and your target block
4747
5. Update the instantiated component with `myVisual.propName`
@@ -51,10 +51,12 @@ Here's the short way to add Svelte component you've written to a Quarto doc:
5151
5252
## 📦 What's in the box?
5353
54+
When you use the Sverto template in a project, it creates some files for you:
55+
5456
* [`example.qmd`](./example.qmd): an example Quarto doc that uses a Svelte component
5557
* [`Circles.svelte`](./Circles.svelte): an example Svelte visualisation
5658
* [`package.json`](./package.json): this is used to keep track of the dependencies of your Svelte components. You should add this to version control.
57-
* Once you've run `npm install`, there'll also be a `package-lock.json` and a `.luarc.json`. You should version control these too (although you oughtn't need to edit them manually).
59+
* Once you've run `npm install`, there'll also be a `package-lock.json` and a `.luarc.json`. You should version control these too (although you oughtn't need to edit them manually). You don't need to touch the `node_modules` folder, either.
5860
5961
See [`example.qmd`](./example.qmd) to learn how to add Svelte components to your documents and the [Svelte tutorial](https://svelte.dev/tutorial/basics) to learn how to create them.
6062

docs/index.qmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ You'll need to install two things to run Sverto:
2525
Install the project extension using:
2626

2727
```sh
28-
quarto use template 360-info/sverto@firstrelease-docs
28+
quarto use template 360-info/sverto
2929
```
3030

3131
Then run:
@@ -52,7 +52,7 @@ Here's the short way to add Svelte component you've written to a Quarto doc:
5252
:::
5353
```
5454
55-
2. Import your Svelte component with `Component = import_svelte("Component.svelte")`
55+
2. Import your Svelte component in OJS with `Component = import_svelte("Component.svelte")`
5656
3. Add a target block for your visual using `:::` and give it an `#id`
5757
4. Instantiate the Svelte component with `myVisual = Component.default()` using some default props and your target block
5858
5. Update the instantiated component with `myVisual.propName`

0 commit comments

Comments
 (0)