removing a module a installed via npm for fun

[random_node_code.git] / tftp / node_modules / tftp-client / README.md

diff --git a/tftp/node_modules/tftp-client/README.md b/tftp/node_modules/tftp-client/README.md
deleted file mode 100644 (file)
index ca09b89..0000000
--- a/tftp/node_modules/tftp-client/README.md
+++ /dev/null
@@ -1,64 +0,0 @@
-# TFTP-Client\r
-\r
-A simple TFTP client for Node.Js.  \r
-*Should not be used in production - first of all: this module is at an early stage (written in less than 12 hours), second: tftp is terrible*\r
-\r
-## Install\r
-\r
-### As a module\r
-`npm install tftp-client`\r
-\r
-### As CLI\r
-`npm install -g tftp-client`\r
-\r
-## Usage\r
-\r
-### Module\r
-\r
-`var client = new TFTP(port, client)` to create a new client.\r
-\r
-`client.read(filename, callback)` to **read** from the server.  \r
- ~ The Callback is passed 2 arguments `(err, data)`, where `data` is the contents of the file.  \r
-\r
-`client.write(filename, data, callback)` to **write** to the server, where `data` is the contents of the file.  \r
- ~ The callback is passed 2 arguments `(err, bytes)`, where `bytes` is the number of bytes sent.  \r
-\r
-**Simple read example:**\r
-\r
-```javascript\r
-var TFTP = require('tftp-client');\r
-\r
-// Initialize the tftp client\r
-var client = new TFTP(69, 'localhost');\r
-\r
-// Read 1.txt from the server\r
-client.read('1.txt', function (err, data) {\r
-       if (err) {\r
-               console.error('ERROR:');\r
-               console.error(err);\r
-               return;\r
-       }\r
-\r
-       console.log('Got data (%d bytes). First 100 bytes:', data.length);\r
-       console.log(data.toString('utf8', 0, 100));\r
-});\r
-```\r
-\r
-### Command line\r
-\r
-To install the tftp-client as CLI, run `npm install -g tftp-client`.\r
-\r
-`tftp-client <hostname> (read|write) <filename> [<port>]`\r
-* hostname - Hostname of tftp server\r
-* read|write - Wether you want to read or write\r
-* filename - Path to the file you want to read or write\r
-* port - Optional. Defaults to 69\r
-\r
-**Example**:\r
-`tftp-client localhost read 1.txt`\r
-\r
-## TODO\r
-\r
-- Error packets - [RFC](http://tools.ietf.org/html/rfc1350#page-8). (implemented, but not tested)\r
-- Do the initial connection as defined in section 4 (TID's: port numbers from request ack) - [RFC](http://tools.ietf.org/html/rfc1350#section-4).\r
-- Currently, any DATA or ACK packet is responded to. Eg. An ACK packet will get a `DATA` response. There is not check for the block numbers to be in order.\r