Skip to content

Commit 676d31a

Browse files
committed
(- doc fix) Add a note to the README about the queueless-rewrite
1 parent c0638c8 commit 676d31a

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.markdown

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,17 @@
22
<img src="http://elliottcable.s3.amazonaws.com/p/paws.js-cathode-3.png"><br>
33
<img alt='Maintenance status: Under rapid development pre-release' src="https://img.shields.io/badge/maintained%3F-pre--release-orange.svg?style=flat-square"><img src="http://elliottcable.s3.amazonaws.com/p/8x8.png"><a href="https://github.com/ELLIOTTCABLE/Paws.js/releases"><img alt='Latest GitHub release' src="https://img.shields.io/github/release/ELLIOTTCABLE/Paws.js.svg?style=flat-square&label=release"></a><img src="http://elliottcable.s3.amazonaws.com/p/8x8.png"><a target="_blank" href="https://npmjs.com/package/paws.js"><img alt='Latest NPM version' src="https://img.shields.io/npm/v/paws.js.svg?style=flat-square&label=semver"></a><img src="http://elliottcable.s3.amazonaws.com/p/8x8.png"><a target="_blank" href="https://discord.gg/Mst2T9wnUY"><img alt='Chat: #ELLIOTTCABLE on Discord' src="https://img.shields.io/discord/706585477351735326?label=%23ELLIOTTCABLE&logo=discord&logoColor=24272a&labelColor=5865F2&style=flat-square"></a><img src="http://elliottcable.s3.amazonaws.com/p/8x8.png"><a target="_blank" href="https://twitter.com/intent/follow?screen_name=ELLIOTTCABLE"><img alt='Follow my work on Twitter' src="https://img.shields.io/twitter/follow/ELLIOTTCABLE.svg?style=flat-square&label=%40ELLIOTTCABLE&color=blue"></a><br>
44
<a target="_blank" href="https://travis-ci.org/ELLIOTTCABLE/Paws.js/branches"><img alt='CI status' src="https://img.shields.io/travis/ELLIOTTCABLE/Paws.js/Current.svg?style=flat-square&label=tests"></a><img src="http://elliottcable.s3.amazonaws.com/p/8x8.png"><a target="_blank" href="https://coveralls.io/r/ELLIOTTCABLE/Paws.js?branch=Current"><img alt='Coverage status' src="https://img.shields.io/coveralls/ELLIOTTCABLE/Paws.js/Current.svg?style=flat-square"></a><img src="http://elliottcable.s3.amazonaws.com/p/8x8.png"><a target="_blank" href="https://gemnasium.com/ELLIOTTCABLE/Paws.js"><img alt='Dependency status' src="https://img.shields.io/gemnasium/ELLIOTTCABLE/Paws.js.svg?style=flat-square&label=deps"></a>
5+
6+
----
7+
8+
A [major rewrite][] of this project started in 2014, and never got merged; if you're curious where
9+
this project ended up, **you should probably go look at the [queueless][] branch. (=**
10+
11+
----
12+
513
</div>
614

15+
716
**Hello, friend.** This is a JavaScript implementation of the Paws machine, intended both to be included
817
into client-side code executed by browsers, and to be embedded into [Node.js][] projects.
918

@@ -48,6 +57,9 @@ All newcomers are welcome, and contribution is hugely appreciated!
4857

4958
</div>
5059

60+
[major rewrite]: <https://www.joelonsoftware.com/2000/04/06/things-you-should-never-do-part-i/>
61+
"You know, *never* a bad idea. Right? ... um ... right??"
62+
[queueless]: <https://github.com/ELLIOTTCABLE/Paws.js/tree/queueless>
5163
[Node.js]: <http://nodejs.org> "A server-side JavaScript platform"
5264
[Paws]: <http://paws.mu> "An asynch-heavy distributed platform for concurrent programming"
5365
[spec]: <http://ell.io/spec> "Specification for the 10th iteration of the Paws design"
@@ -63,7 +75,7 @@ querying the executable at the command-line:
6375
./Executables/paws.js interact # Example, opens an interactive ‘REPL’ to play with
6476

6577
As for embedding the `Paws.js` API, you'll have to dive into the code and poke around a bit, for the
66-
moment. I'm also happy to give you a quick overview, if you join [our channel][webchat] and ask!
78+
moment. I'm also happy to give you a quick overview, if you join our Discord and ask!
6779

6880
*(I swear, API documentation is coming soon! `:P` )*
6981

@@ -79,11 +91,12 @@ course.
7991
After `git clone`'ing the codebase, you should immediately `npm run-script hi`; this will help you
8092
set up your local copy for hacking.
8193

82-
More specific information ~~can be found in [CONTRIBUTING](./blob/Master/CONTRIBUTING.markdown)~~.
83-
(Well, eventually. `>,>`)
94+
More specific information can be found in the [CONTRIBUTING][] file.
8495

8596
[CoffeeScript]: <http://coffeescript.org> "A little language that transpiles into JavaScript"
8697
[issues]: <https://github.com/ELLIOTTCABLE/Paws.js/issues> "Issue-tracker for Paws.js"
98+
[CONTRIBUTING]: <./blob/current+/CONTRIBUTING.markdown>
99+
"CONTRIBUTING.markdown on the current+ branch"
87100

88101
<br>
89102
----

0 commit comments

Comments
 (0)