Skip to content

Commit

Permalink
merge: Merge pull request #28 from henryhale/docs/update
Browse files Browse the repository at this point in the history
docs: update readme links and ci deploy
  • Loading branch information
henryhale committed Oct 7, 2023
2 parents 2986705 + eed9308 commit e7e4e56
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
5 changes: 4 additions & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
name: Deploy to GitHub Pages
name: Deploy Documentation

on:
push:
branches:
- master
paths:
- docs/**
- README.md

permissions:
contents: write
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ By combining the best features and ideas from these sources, this library aims t

## Live Demo

There is a quick demo online: [Try It Yourself](https://henryhale.github.io/xterminal/demo/).
There is a quick demo online: [Try It Yourself](https://xterminal.js.org/demo/).

## Getting Started

Expand Down Expand Up @@ -54,11 +54,11 @@ Import the package and create a new instance of the `XTerminal` class:
</script>
```

For more detailed information, please refer to the [official documentation](https://henryhale.github.io/xterminal/) online.
For more detailed information, please refer to the [official documentation](https://xterminal.js.org/) online.

## Documentation

The complete documentation for `XTerminal` can be found [here](https://henryhale.github.io/xterminal/). It provides detailed information on installation, configuration, usage, and advanced features. You'll also find code examples and API references.
The complete documentation for `XTerminal` can be found [here](https://xterminal.js.org/). It provides detailed information on installation, configuration, usage, and advanced features. You'll also find code examples and API references.

The full Public API for `XTerminal` can also be found within this [TypeScript declaration file](https://github.com/henryhale/xterminal/blob/master/source/types.ts).

Expand Down

0 comments on commit e7e4e56

Please sign in to comment.