Skip to content

Latest commit

 

History

History
59 lines (39 loc) · 1.78 KB

README.md

File metadata and controls

59 lines (39 loc) · 1.78 KB
Raw

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

  1. edit ./modules.md to include your module within the appropriate category.
  2. submit a pull request here to apply this change.
  3. 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

license

The Apache License

Copyright © 2016 Michael Williams

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.