Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
arianrhodsandlot committed Nov 5, 2023
1 parent 17ea613 commit ddd5cd9
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 11 deletions.
1 change: 0 additions & 1 deletion docs/astro.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ export default defineConfig({
},
social: {
github: 'https://github.com/arianrhodsandlot/nostalgist',
twitter: 'https://twitter.com/arianrhodsand',
},
customCss: ['./src/styles/custom.css'],
editLink: {
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/guides/related.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ title: Related
+ [jsDelivr](https://www.jsdelivr.com/)

## Showcases
+ [Retro Assembly](https://github.com/arianrhodsandlot/retro-assembly)
+ [RetroAssembly](https://github.com/arianrhodsandlot/retro-assembly)

A web app with which you can build a custom retro gaming library inside your browser.
Game states can be synced with cloud storage services like OneDrive/Google Drive/Dropbox
Expand Down
10 changes: 3 additions & 7 deletions docs/src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ Nostalgist.js is a JavaScript library that allows you to run emulators of retro
<a class="home-button" title="API reference" href="/apis">API reference</a>
</p>

---

---
:::tip
⚠️ Nostalgist.js is for developers. If you are a player and prefer playing games you own in browsers, rather than building something with code, you may want to try another open-source projects [RetroAssembly](https://github.com/arianrhodsandlot/retro-assembly).
:::

## A Quick Glance
Nostalgist.js is a JavaScript library that allows you to run emulators of retro consoles like NES and Sega Genesis, within web browsers.
Expand Down Expand Up @@ -170,10 +170,6 @@ The purpose of Nostalgist.js is to simplify the process of launching an emulator
href="/guides/getting-started"
/>

:::tip
⚠️ Nostalgist.js is for developers. If you are a player and prefer playing games you own in browsers, rather than building something with code, you may want to try another open-source projects [Retro Assembly](https://github.com/arianrhodsandlot/retro-assembly).
:::

:::caution[Caveat]
Nostalgist.js **DOES NOT** provide any pirated content, like copyrighted ROM files or BIOS files. And it **DOES NOT** encourage that.
:::
4 changes: 2 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

Nostalgist.js is a JavaScript library that allows you to run emulators of retro consoles, like NES and Sega Genesis, within web browsers.

> ⚠️ Nostalgist.js is for developers. If you are a player and prefer playing games you own in browsers, rather than building something with code, you may want to try another open-source project [Retro Assembly](https://github.com/arianrhodsandlot/retro-assembly).
> ⚠️ Nostalgist.js is for developers. If you are a player and prefer playing games you own in browsers, rather than building something with code, you may want to try another open-source project [RetroAssembly](https://github.com/arianrhodsandlot/retro-assembly).
## A Quick Glance
<p align="center">
Expand Down Expand Up @@ -106,7 +106,7 @@ Please refer to [nostalgist.js.org/apis](https://nostalgist.js.org/apis).
+ [jsDelivr](https://www.jsdelivr.com/)

### Showcases
+ [Retro Assembly](https://github.com/arianrhodsandlot/retro-assembly)
+ [RetroAssembly](https://github.com/arianrhodsandlot/retro-assembly)

A web app with which you can build a custom retro gaming library inside your browser.
Game states can be synced with cloud storage services like OneDrive/Google Drive/Dropbox
Expand Down

0 comments on commit ddd5cd9

Please sign in to comment.