Skip to content

Commit

Permalink
Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
jichu4n committed Jul 4, 2024
1 parent 8e3da03 commit 6c6befe
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

[![Build Status][build-status-image]][github-url]

**palm-sync** is a TypeScript toolkit for performing HotSync with Palm OS devices.
**palm-sync** is a modern, cross-platform toolkit for HotSync with Palm OS devices, built with TypeScript.

palm-sync provides a new implementation of HotSync in TypeScript, and supports Node.js and browser environments on current mainstream OS platforms. Its goal is to provide a suite of libraries and tools that can pave the way for a modern cross-platform Palm Desktop alternative.
palm-sync provides a new implementation of Palm HotSync protocols in TypeScript, and supports Node.js and browser environments. It aspires to be the foundation for a new generation of Palm OS synchronization tools for modern operating systems.

## Supported platforms and features

Expand Down Expand Up @@ -71,22 +71,21 @@ palm-sync provides a new implementation of HotSync in TypeScript, and supports N

Not supported:

- **Platforms**: iOS, iPadOS
- **Operating systems**: iOS, iPadOS
- **Connections**: Bluetooth, IR

For more information, please see Connecting Palm OS Devices.

## Web demo

If you have a Palm OS device, you can try out palm-sync right in your browser! The web demo allows you to do a simple HotSync over a USB or serial connection.
You can try out palm-sync right in your browser! The web demo allows you to do a simple HotSync with a Palm OS device via USB or serial.

👉 [ **jichu4n.github.io/palm-sync/web-demo** ](https://jichu4n.github.io/palm-sync/web-demo/)

Requirements:

- **Connection**: Palm OS device connected via USB or serial, including via a serial-to-USB adapter.
- **OS**: Windows, macOS, Linux, ChromeOS, or Android. See Connecting Palm OS Devices for OS-specific configuration.
- **Browser**: A Chromium-based browser such as Google Chrome or Microsoft Edge.
- Palm OS device connected via USB or serial, including via serial-to-USB adapter.
- A Chromium-based browser such as Google Chrome or Microsoft Edge, running on Windows, macOS, Linux, ChromeOS, or Android (USB only). See Connecting Palm OS Devices for OS-specific setup.

## Quickstart

Expand Down Expand Up @@ -133,7 +132,7 @@ npm run build
./node_modules/.bin/palm-sync run --usb ./dist/list-dbs.js
```

Now connect and initiate HotSync on the Palm OS device! See Connecting Palm OS Devices for OS-specific configuration steps.
Now connect and initiate HotSync on the Palm OS device! See Connecting Palm OS Devices for OS-specific setup.

## API

Expand Down

0 comments on commit 6c6befe

Please sign in to comment.