From a81486d2db5ffdec78f125b2c75ed925727af20e Mon Sep 17 00:00:00 2001 From: indolering Date: Thu, 6 Nov 2014 18:19:02 -0800 Subject: [PATCH 1/3] Moved stuff to wiki --- README.md | 49 +------------------------------------------------ 1 file changed, 1 insertion(+), 48 deletions(-) diff --git a/README.md b/README.md index f24e240..ec5b929 100644 --- a/README.md +++ b/README.md @@ -3,51 +3,4 @@ Speech.js is a JavaScript interoperability mechanism for Namecoin domains. It po This repo is in a state of flux as I am refactoring the meta-aspects of the project such as the server setup & babel.js. -If you want to play around, stick to items in src and dist. The SPX submodule will be removed entirely. - -#Breakdown -The structure of the program is relatively OO and breaks down into functional network components. The meat of the -system lies in the `dns` and `nav` scripts. - - -## DNS -DNS essentially reimpliments the DNS layer of the networking stack. Currently, it relies on a traditional client/server -model as the TPP has not yet been passed and it is still safe to provide DNS information directly. Speech.is runs a VM -with a script known as [nmc2couch](https://github.com/indolering/nmc2couch) which pushes Namecoin domain data to a -CouchDB instance. Using the internal network, the original CouchDB instance replicates to another CouchDB install on a -public-facing VM. - -There is a thin abstraction layer build on top of PouchDB, but most of it translates into get requests. Upon loading, -speech.js creates a connection to the CouchDB server and begins replicating. - -The system was originally designed to have many different publishes/mirrors, to allow for per-website over-rides. Thus, - if a user is in a censored country, they could register a webhook would would offer up a custom entry point. It is -unclear if this ist he correct layer of abstraction for personalized entry points, but it remains in the system for now. - -Eventually, this will be replaced by a browser/WebRTC-based P2P network. This was not implemented in the initial phase -to allow browser-based P2P networks and Bitcoin/Namecoin UTXO/SCIP lite-clients time to mature. - -## Nav -Navigation essentially manages the addresses bar and the history state. This is the least functional component of the -system, largely because it leaves functionality in-tact while irritating potential developers who might be driven to -scratch an itch and contribute back to the project. - -## Config -Config should be replaced with [Puton](https://github.com/speech/speech.js/issues/22). - -## Misc -The other libraries are fairly short. PR's explaining them in better detail are welcomed. - -# Package Management - -NPM and Bower are used in this project: - -* NPM is used for developer package management: mocha, gulp, memdown, leveldb, etc. -* Bower is used for client-side asset management: PouchDB, Ready.js, JQuery, etc. - -Items packaged for Bower are generally packaged for use within a web browser wheras NPM packages are generally designed -for use within Node.js. Bower is strictly used to manage assets, not for dependencies nor anything else. This enables -Speech.js, spx, and babel.js to reference specific items in each of those packages without having to take on the entire - install. - -NPM helps to manage the complex machinery that is the compiler along with all of it's dependencies. \ No newline at end of file +Check out [the wiki](https://github.com/speech/speech.js/wiki) for an architectural overview. \ No newline at end of file From d97b4ebca78e6770aca9154e438bd012db868b21 Mon Sep 17 00:00:00 2001 From: indolering Date: Thu, 6 Nov 2014 18:20:46 -0800 Subject: [PATCH 2/3] minor --- .gitignore | 1 - README.md | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 4426dc8..8144355 100644 --- a/.gitignore +++ b/.gitignore @@ -2,7 +2,6 @@ node_modules dist .tmp .sass-cache -app/bower_components .idea .iml speechjs.iml diff --git a/README.md b/README.md index ec5b929..757e99e 100644 --- a/README.md +++ b/README.md @@ -3,4 +3,4 @@ Speech.js is a JavaScript interoperability mechanism for Namecoin domains. It po This repo is in a state of flux as I am refactoring the meta-aspects of the project such as the server setup & babel.js. -Check out [the wiki](https://github.com/speech/speech.js/wiki) for an architectural overview. \ No newline at end of file +Check out [the wiki](https://github.com/speech/speech.js/wiki) for an overview of the architecture. \ No newline at end of file From da160035ac68a176fa5429604e4185bb7cfdd86d Mon Sep 17 00:00:00 2001 From: Zach Lym Date: Mon, 30 Mar 2015 15:52:46 -0600 Subject: [PATCH 3/3] Deprecated --- README.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/README.md b/README.md index 757e99e..ed81b35 100644 --- a/README.md +++ b/README.md @@ -1,6 +1 @@ -#Introduction -Speech.js is a JavaScript interoperability mechanism for Namecoin domains. It powers [Speech.is](https://www.speech.is). - -This repo is in a state of flux as I am refactoring the meta-aspects of the project such as the server setup & babel.js. - -Check out [the wiki](https://github.com/speech/speech.js/wiki) for an overview of the architecture. \ No newline at end of file +This codebase has been deprecated as Speech.is retools for a different technology. You can find more information at our [blog](http://speech-is.tumblr.com/post/115059190532/pivot).