Skip to content

Commit

Permalink
docs(readmr): create readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
syroegkin committed May 13, 2023
1 parent 76464db commit 1fb9bd8
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# nxtp-js

nxtp-js is a JavaScript implementation of the nxtp library, developed for the ZX Spectrum Next computer. It provides a convenient method for configuring the local time on vintage computers that possess both a Real Time Clock (RTC) and a network interface.

This library is inspired by the original [nxtp](https://github.com/Threetwosevensixseven/nxtp) project for the ZX Spectrum Next.



## Installation

To use this project, you need to have Node.js version 18 or higher installed. As an alternative you can use nvm.


```shell
git clone https://github.com/syroegkin/nxtp-js.git
nvm use # if you use nvm
npm install
npm run build
npm start
```

By default, the library listens on port 12300. However, you can configure a different port by setting the environment variable **PORT**:

```shell
PORT=12500 npm start
```

The public time server is available at http://time.zx.in.net:12300

ZX Spectrum Next is a trademark of SpecNext Ltd.

0 comments on commit 1fb9bd8

Please sign in to comment.