pull-stream / pull-stream-docs Goto Github PK

View Code? Open in Web Editor NEW

11.0 6.0 18.0 78 KB

source code to aggregate pull stream ecosystem docs

Home Page: https://pull-stream.github.io

JavaScript 100.00%

pull-stream-docs's Introduction

pull-stream-docs

uses ecosystem-docs to aggregate modules within the pull-stream ecosystem, both inside the pull-stream org and out.
using inu to render a static website to discover and reference modules within the pull-stream ecosystem.

the list of modules included within the ecosystem is ./modules.md.

the built output is pull-stream/pull-stream.github.io which is rendered at https://pull-stream.github.io.

adding a module to the ecosystem

edit ./modules.md to include your module within the appropriate category.
submit a pull request here to apply this change.
a pull-stream maintainer will merge your change and re-deploy the website.

maintainer how to

install

git clone git://github.com/pull-stream/pull-stream-docs
cd pull-stream-docs
npm install

start development server

npm start

deploy to production

npm run deploy:remote
npm run deploy

inspiration

stackgl/packages

license

The Apache License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

pull-stream-docs's People

Contributors

Stargazers

Watchers

Forkers

dignifiedquire regular rjmk pietgeursen nichoth elavoie santiagogil alanshaw amsross jdvorak reqshark nrkn maackle davidchase brechtcs jacobbubu devinivy

pull-stream-docs's Issues

automated deploy is broken

https://travis-ci.org/pull-stream/pull-stream-docs/builds/244385632

full log: https://api.travis-ci.org/jobs/244385633/log.txt?deansi=true

/home/travis/build/pull-stream/pull-stream-docs/scripts/index.js:9
  if (err) throw err
           ^

Error: Bad credentials
    at Request._callback (/home/travis/build/pull-stream/pull-stream-docs/node_modules/ecosystem-docs/sync.js:139:37)
    at Request.self.callback (/home/travis/build/pull-stream/pull-stream-docs/node_modules/ecosystem-docs/node_modules/request/request.js:188:22)
    at emitTwo (events.js:87:13)
    at Request.emit (events.js:172:7)
    at Request.<anonymous> (/home/travis/build/pull-stream/pull-stream-docs/node_modules/ecosystem-docs/node_modules/request/request.js:1171:10)
    at emitOne (events.js:77:13)
    at Request.emit (events.js:169:7)
    at IncomingMessage.<anonymous> (/home/travis/build/pull-stream/pull-stream-docs/node_modules/ecosystem-docs/node_modules/request/request.js:1091:12)
    at IncomingMessage.g (events.js:260:16)
    at emitNone (events.js:72:20)

babel-plugin-pull

I created this Babel plugin inspired from pull-stream/pull-stream#90 that lets you use a "pipe operator":

oscillator({ wave: 'sine' })
| gain(0.5)
| speaker()

One of the more major benefits over the other plugins is you can compose things together in a really nice way:

// Create a source
const baz = foo() | bar()

// Use it
baz 
| qux()
| oof()

I was wondering where I should list this in the docs.

Core header links are broken

At the moment clicking on the links on the modules under the core section they end up on a 404 page on github, e.g. on https://pull-stream.github.io/#/take it will send you to https://github.com/pull-stream/pull-stream/blob/master/throughs/take.md which does not exist anymore.

Which projects are using pull-streams?

Hi all,

I am writing an academic paper that compares pull-streams with other programming approaches and in order to get academics interested I need to make a case that pull-streams are both interesting from a design point of view and used by real world projects. Which end-user applications, protocols, or libraries are you using pull-streams for? The higher profile the better as it increases the possibility that academics will have heard of it. Otherwise, cool applications that would have been too complicated to write in other styles also qualify.

So far @dominictarr told me js-ipfs and ssb are the biggest ones. Do you know of any others?

pull-await: await syntax on promises in pull streams

I have made a pull-stream module, but I'm confused about adding it. I don't know if there is specific requirements and how to add it to the docs here.

You can check it at jamen/pull-stream. It basically ends up looking like this inside of pull-stream:

var await = require('pull-await');

pull(
  // Pass any regular data or promises
  pull.values([
    'hello',
    Promise.resolve('world').delay(250),
    request('https://registry.npmjs.org/pull-stream/0.1.0')
  ]),

  await, // use pull-await to resolve them.

  pull.collect(function(err, data) {
    console.log(data);
  });
);

This is my first module, pretty new, but it is awesome so far. :)