-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
23 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,24 @@ | ||
# Sirin | ||
CLI to share files of all kinds to anyone connected to your network | ||
[![npm version](https://badge.fury.io/js/sirin.svg)](https://badge.fury.io/js/sirin) ![size](https://badgen.net/npm/types/sirin) ![size](https://badgen.net/packagephobia/publish/sirin) | ||
|
||
CLI to **instantly** share a directory and its contents to anyone connected to your network over HTTP, be it LAN or your hotspot. Doesn't require internet. | ||
|
||
# Installation | ||
Make sure you have NodeJS [installed](https://nodejs.org/en/) and have NPM as well | ||
``` | ||
npm i -g sirin | ||
``` | ||
|
||
# Usage | ||
``` | ||
sirin | ||
``` | ||
|
||
For further options, use the `-h` flag | ||
``` | ||
sirin -h | ||
``` | ||
|
||
and then you can visit the provided url on any device connected to your network. URL can be used to access the files. | ||
|
||
If the exposed directory is `/home/ubuntu/hello` and the url is `http://192.16.188.40:3000`, then visiting `http://192.16.188.40:3000/hi/bye/foo.txt` will be equivalent to accessing `/home/ubuntu/hello/hi/bye/foo.txt` |