mirror of
https://github.com/YGGverse/nps-php.git
synced 2025-01-15 17:30:08 +00:00
update readme
This commit is contained in:
parent
a922d25c43
commit
2b735f6f5b
30
README.md
30
README.md
@ -2,6 +2,36 @@
|
|||||||
|
|
||||||
PHP 8 / Composer Library for NPS Protocol (see also [nex-php](https://github.com/YGGverse/nex-php))
|
PHP 8 / Composer Library for NPS Protocol (see also [nex-php](https://github.com/YGGverse/nex-php))
|
||||||
|
|
||||||
|
## About
|
||||||
|
|
||||||
|
Like Titan for Gemini, NPS is the satellite for Nex protocol\\
|
||||||
|
it uses dot in line to signal the package ending.
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
|
1. `nc nightfall.city 1915` - connect server using `nc`
|
||||||
|
2. `classifieds` - enter the target path
|
||||||
|
3. `YOUR MESSAGE GOES HERE` - enter the message text
|
||||||
|
4. `.` - commit package with dot
|
||||||
|
|
||||||
|
To send any file:
|
||||||
|
|
||||||
|
* `nano file.txt`
|
||||||
|
|
||||||
|
``` file.txt
|
||||||
|
classifieds
|
||||||
|
╦ ╦╔═╗╔═╗╔╦╗╦═╗╔═╗╔═╗╦╦
|
||||||
|
╚╦╝║ ╦║ ╦ ║║╠╦╝╠═╣╚═╗║║
|
||||||
|
╩ ╚═╝╚═╝═╩╝╩╚═╩ ╩╚═╝╩╩═╝
|
||||||
|
.
|
||||||
|
```
|
||||||
|
|
||||||
|
* `cat file.txt | nc nightfall.city 1915`
|
||||||
|
|
||||||
|
### Specification
|
||||||
|
|
||||||
|
`nex://nightfall.city/nps/`
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
```
|
```
|
||||||
|
Loading…
x
Reference in New Issue
Block a user