Permalink
Browse files

Converted README files to Markdown format

  • Loading branch information...
1 parent df17be5 commit 08ea6f57f5af1ad3633289358130e7421cffe03e Tim Whitlock committed Aug 2, 2010
View
17 README
@@ -1,17 +0,0 @@
-node-amf
---------
-AMF library for NodeJS
-@author Tim Whitlock http://twitter.com/timwhitlock
-
-Currently in an alpha state.
-
-Run "node test.js" to perform a simple serialize & deserialize test
-see the examples directory for client/server tests
-
-
-Known issues
-------------
-NodeJS has a habit of changing and depreciating function names.
-If you get missing function errors, then you need to upgrade NodeJS.
-See http://github.com/timwhitlock/node-amf/commit/62a85b8531307c86ff27daa21e48012a7558552a
-
View
34 README.md
@@ -0,0 +1,34 @@
+# node-amf
+
+AMF module for NodeJS by [Tim Whitlock](http://twitter.com/timwhitlock)
+
+## About
+
+A pure JavaScript implementation of [AMF](http://en.wikipedia.org/wiki/Action_Message_Format) designed for NodeJS.
+Can be used to create an AMF web services gateway over HTTP allowing a Flash Player client to communicate with a remote server.
+
+Run "node test.js" to perform a simple serialize & deserialize test. Check that the output matches the variables show in the script.
+
+To test a simple AMF gateway: configure and run the HTTP server in examples/http-server, then configure and run the Flash client in example/http-client.
+
+Also in this project is some experimental work implementing RTMP. This should probably be split into its own project.
+
+
+## Status
+
+* The AMF library is largely complete and working, but not thoroughly tested.
+* The RTMP work is experimental and not ready for use.
+
+
+## Known issues
+
+NodeJS has a habit of changing and depreciating function names.
+If you get missing function errors, then you need to upgrade NodeJS.
+See http://github.com/timwhitlock/node-amf/commit/62a85b8531307c86ff27daa21e48012a7558552a
+
+AMF0 is only partially supported, due to it being depreciated. AMF3 should be used by all clients.
+
+
+## License
+
+node-amf is dual licensed under the MIT and GPL licenses, See LICENSE.
View
6 examples/http-client/README.md
@@ -0,0 +1,6 @@
+# Example Flash AMF client
+
+This client connects to the simple AMF gateway example in ../http-server
+
+* Configure and run the ../http-server/run-server.js example to run the server under NodeJS.
+* Configure network settings in NodeAmfConnection.as and test movie from http-client.fla
View
5 examples/http-client/README.txt
@@ -1,5 +0,0 @@
-http-client for node-amf
-
-This is a Flash front end for testing a NodeJS HTTP server with an AMF gateway configured.
- - Configure and run the ../http-server/run-server.js example to run the server.
- - Configure network settings in NodeAmfConnection.as and test movie from http-client.fla
View
5 examples/http-server/README.md
@@ -0,0 +1,5 @@
+# Example AMF gateway for NodeJS
+
+This is the standard way to implement a RESTful AMF web services gateway over HTTP.
+* Configure your available web service methods in amf-methods.js
+* Configure and execute run-server.js to start the server.
View
5 examples/http-server/README.txt
@@ -1,5 +0,0 @@
-http-server for node-amf
-
-This is an example AMF gateway for NodeJS over HTTP
- - Configure your available web service methods in amf-methods.js
- - Configure and execute run-server.js to start the server.
View
6 examples/rtmp-client/README.md
@@ -0,0 +1,6 @@
+# Example RTMP client
+
+Used for testing the experimental RTMP server at ../rtmp-server
+
+This work is incomplete and not ready for use
+
View
3 examples/rtmp-client/README.txt
@@ -1,3 +0,0 @@
-This is a test client for the RTMP server which is in development
-
-
View
3 examples/rtmp-server/README.md
@@ -0,0 +1,3 @@
+# Example RTMP server
+
+See ../../node-rtmp
View
9 examples/rtmp-server/README.txt
@@ -1,9 +0,0 @@
-An attempt to implement a RTMP socket server in NodeJS.
-This is under heavy development - i.e. it's incomplete, don't use it.
-
-Status:
-- Handshake is working.
-- Currently working on message chunking.
-
-See:
-http://www.adobe.com/devnet/rtmp/
View
27 examples/rtmp-server/rtmp-test.js
@@ -4,13 +4,6 @@
var sys = require('sys');
var net = require('net');
-var utils = require('../../node-amf/utils');
-var amf = require('../../node-amf/amf');
-var bin = require('../../node-amf/bin');
-var pack = require('../../node-amf/pack').pack;
-var unpack = require('../../node-amf/unpack').unpack;
-
-
var RtmpConnection = require('../../node-rtmp/RtmpConnection').RtmpConnection;
@@ -22,6 +15,7 @@ var server = net.createServer();
/** */
server.addListener('connection', function( socket ) {
try {
+ sys.puts('server.connection');
new RtmpConnection( socket );
}
catch( Er ){
@@ -33,27 +27,10 @@ server.addListener('connection', function( socket ) {
/** */
server.addListener('close', function(errno) {
- sys.puts('server:close '+errno);
+ sys.puts('server.close '+errno);
} );
server.listen( 1935, "192.168.51.6" );
sys.puts('Server ready');
-
-
-
-
-// utility
-function randomness( len ){
- var s = '';
- for( var i = 0; i < len; i++ ){
- s += String.fromCharCode( Math.round( 255 * Math.random() ) );
- }
- return s;
-}
-
-
-
-
-
View
11 node-rtmp/README.md
@@ -0,0 +1,11 @@
+# node-rtmp
+
+## About
+
+An attempt to partially implement [RTMP](http://en.wikipedia.org/wiki/Real_Time_Messaging_Protocol) for NodeJS in pure JavaScript.
+Only the messaging aspects of the protocol are of interest at this point. Streaming media is not currently a concern.
+
+## Status
+
+This is only in early development. Don't try and use it for anything.
+I am currently struggling with Adobe's badly written specification.
View
1 test.js
@@ -10,7 +10,6 @@ var sys = require('sys');
// require node-amf module libraries from relative directory path
var amf = require('./node-amf/amf');
var utils = require('./node-amf/utils');
-var utf8 = require('./node-amf/utf8');

0 comments on commit 08ea6f5

Please sign in to comment.