Skip to content
Permalink
Browse files

Add README and CircleCI (#1)

* init readme

* readme

* test section

* add license

* license

* readme

* readme

* license

* comma

* rm

* circle

* circle

* build status

* upgrade node

* rm yarn call

* copy stuff from doc gen pr

* update readme

* add typedoc

* cr feedback

* home dir

* update url

* fix urls

* fix url

* cleanup

* rm space

* dist

* owners

* full url for docs badge

* rm makefile

* docs command

* build docs in ci

* destinations
  • Loading branch information...
eugeneiiim committed Mar 6, 2019
1 parent d31e34a commit 25b8c93ead8927b468cc2d0f33ab3ad7ce4c3328
Showing with 384 additions and 58 deletions.
  1. +20 −0 .circleci/config.yml
  2. +1 −1 .github/CODEOWNERS
  3. +1 −0 .gitignore
  4. +21 −0 LICENSE
  5. +39 −0 README.md
  6. +1 −1 dist/src/delay.js.map
  7. +1 −0 docs/badge.svg
  8. +11 −0 docs/current-version.js
  9. +15 −0 docs/update-versions.js
  10. +268 −52 package-lock.json
  11. +5 −3 package.json
  12. +1 −1 src/delay.ts
@@ -0,0 +1,20 @@
version: 2
jobs:
build:
docker:
- image: circleci/node:10.15

working_directory: ~/repo

steps:
- checkout
- run: npm ci
- run: npm test
- run: npm run docs

- store_artifacts:
path: coverage
destination: coverage
- store_artifacts:
path: docs-build
destination: docs-build
@@ -1 +1 @@
* @clayton @forest @austin
* @ftrimble @eugeneiiim
@@ -11,3 +11,4 @@ resources
tscommand-*
.tscache/
dist/test
docs-build/
21 LICENSE
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2019 Blend Labs, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
@@ -0,0 +1,39 @@
promise-utils
=============

[![Build Status](https://circleci.com/gh/blend/promise-utils.svg?style=shield)](https://circleci.com/gh/blend/promise-utils)
[![Documentation](https://github.com/blend/promise-utils/blob/master/docs/badge.svg)](https://github.com/pages/blend/promise-utils/)

Promise-utils is a JavaScript/TypeScript library that provides
Lodash-like utility functions for dealing with promises.

## Installation

```
$ npm install promise-utils
```

## API

- [Documentation][2]
- [Past versions][3]

## Test

```
$ npm test
```

## Documentation

```
$ npm run docs
```

## License

[MIT](LICENSE)

[1]: https://blend.github.io/promise-utils
[2]: https://blend.github.io/promise-utils/latest/
[3]: https://blend.github.io/promise-utils/versions.html

Some generated files are not rendered by default. Learn more.

Oops, something went wrong.
@@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="153" height="40"><linearGradient id="b" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="a"><rect width="153" y="10" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#a)"><path fill="#d3d3d3" d="M0 10h118v20H0z"/><path fill="#4c1" d="M118 10h35v20H118z"/><path fill="url(#b)" d="M0 10h153v20H0z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110"><image x="5" y="3" width="32" height="32" xlink:href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADoAAAA6CAYAAADhu0ooAAAAAXNSR0IArs4c6QAAAAlwSFlzAAAWJQAAFiUBSVIk8AAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KTMInWQAACAtJREFUaAXtWmtsHNUVvnce+17HjtdOMClEjW0QxnVbrxMXOY5XgUTmEWTIBjkSqUlap1RYvGl/VPUSqS2hrROFR6MNEB6CH1kBQkIkIgIvOLUKteu21DySJUFJSNa1HbOx9z0zt+dcry2bRlmXmbhGmivt7MydO3fOd86553zn7hJiNlMDpgZMDZgaMDVgasDUwHxpwH/ggOgfHLQEAgFhvt457+/5OjgEPe9C5HkhzXM/723GGIXGtnX3lwsivdx2mfsvT1RUpPM+OM8DdLvZ9mC/hDKLMmt1LC4Mp6Oxk+3v9+3AvgBjuufHeYxougUpqxxnXBCVZNVMhlgLCkoJJeuwr5MQMDjT7TULAui0ELgqAZKSSgE8EpvqXxAoQRjdFp0CNPVNKUxJ6YILRoYD5YCZNoV7wXwbDDTnqAvFX2eo2WCgk3FpxvwL5tRgoLNxoWE5dIi8SCow3cwgF3h73mzPc+Bs8Yy4Eji+joMHLdtLSzXi9SoBQjQSgCM0/wEmhjZRFU4pqW2XifsoI+Gwwm9eooPBFp2yIeNR94kbb0wHvd4syM6Bt3V32xAHgvR3HbDz/v5gloOs8lvg+pJZ2GCLMkIFAbILSSKg9t6+aqLQZiqwWo2RKwBFYXtPn2ZzOLfsqV2zZtnatlvjscRezSYdih15ZQyfAasL8DE8bBtqUcyhajYLdIhc3t7T/xxRyT8sLudOW2HRJqenpN7idF0NzOmadDJ5eOPLez8//c4Jh6t0ySuywgZKVm2+NwdUI36/4XnYUKBoSk1RMlQQa2SH4y6wLmWaSpJj584nRv49mE1MjGbjceLweIpKVqzY/9Pw739+6q3eN2Wn+0oiSbs99a1vcJChkGo0WGOBgknAPQUAp2TjE4pktZJsMrFfky1VZQ3e74kW+7WqomyMDw8HlXTaJlrkP991aNcz0aNn3xNEcHnJusFzWnqDWxbBGtgMBZoLRRg9RYu7QMqkkg8HV9dtfaa+5nSAUu3plVXRfY11rwZX1253yUqxkkndaytadPNtj7VtHR+N9YM/ECpabvKsan2QY8SIbFAzLBgxTaOapmG5IltdbsrUbNu+Bu8L7X19XFiMvphHBz/+WCpKJtkurxcD1p/gg+tRJY4bNjgKbB9RKi0Gt3hkUcPm52JHgmPTrqwTsGFAKaGKIIpEtttFALntqbrq8au3PFAJAI+CjNxz0KpwnkGZm7q7peWESM/7fFDuEJkkDp8hautjRKaPU0EqlbOqH/qD5RNLpQgqQmfT7bpn3G6e+5jG7FZ3AbEtcm18qs5XvHTNnY9++mIXggSG4OdjZsoa9vkUBIn1anlHB5dDFIVDoKQ0EcDIlPlwfMQVxaXwX8/PnGsu57qBjh0/PpnzYKbs+dj9XZXLnWXX+x9nivYsClDe3GwlFwksuA0T6U3zORSSOQePjOf4RQUHMBmBdcupe4LQpk0opLCvceWO3Tfdz0oa2l7IJmJqRtHeRUEjJ11zZvoiFZA5WTARQysoq73FgSdkePj/b1HgqrjONbK0eeOS73p2U1hOmso+G1Pcn3Ahr8m/vspjp7jCVUaXQy4ugMAG3iuIanGhboBcBjjotihxl3H1L60svhbWG4IkAqWfEuSwTU3Sxdx2SoiIddLqkEnrcDlKVgswLDU29PZLcT4m3DS5PKYe+Abf+oGOn+Faz2a1EbQEcl1GGARKaMMlc5gfuO1giEdiUNJKoIlkYiR2dvRfsW05PBCZ9HPfOQiSe12+L419lVtbEEvYMA4vv2Iiv+s1hSdlWLZ+scVuaTnz91NDP2r13XnPkS4/bIS7YBrViA1x/UBTYxwM8PlTyGvBpLDMBA8CjRzDY77WxAcsr/7OlpEvY7Galuq1Fdc37kyNj98BgW4Cb1b5/XMOaHyyCxz0A7UVcSGoonwG8w8R2BiDlXo75BUriRzEHXshAOQArHLhejMcUDCXfnHwC1fldVe1rP7Zj3c6l1xWCzn1bZQXn80RDbz8xk0/M+oPKkjThkOhaEl9ay/4bQvw1XKPp3DHSIT8AswhBXy+aTZUnUyK0eZmJUT5DgNpO3HCBrk0BVSxS8iIh6koXTcRPQueQT9EVKPLliFFRNKgq+kHitn9eBF6hgrs6LeEqi0EqmzJZn2EkBXdv+p96fOhgYd+IjO662nfymh4ptBgyecB5N09/yxSU5l3ZZfz+6nx87C1z8aInb6GyKIDA7pB4jz5gwWOmkvDSgNSCtSUD0C59UeiZYmqqFl7kWP97b97eJ2iqr+E0uxVppLXqch6gg3ekzjt9t6/rdVU7VmL3XEllHRxR7HHmRgZ7gg21j2JBUFuK2YuElx0jHFA+WsgVUAq8NRvDkDx3SnIEkmdn0jGBkI/uO+T4+skq2MPFOFYo56DlBuBl0vgtj8UZBkLduDJhSR5buzJYGNtB65bpIcXlf5/uGkwUPSQAH604lWbbwXC9BvZ4axiqkaG3t/ffPcHH1VAsb0HKh0iQlGOOVdJp+D3mjRRM+kvBUYf3dtYuw/lX+hAUUYKjEjkO3vAjIoTpTdLFtkPvdVDPS/fcs9fB9enE/FfU4GeBcCjSC6oJvS4C6U3/1BTE8d9387OTjSnYdZEoS5dm9y+nJ4fk/5VG7a6saPj2DErpo3pm7kT/GvA1/u+Hde4m4eAZ+zqNQVmA0QF8P8+XAD4twPkbClpDiyPCQguwH+egF/EIejMHmpemRowNWBqwNSAqQFTA6YGTA2YGjBEA/8BRTEL+O3W0JEAAAAASUVORK5CYII="/><text x="775" y="250" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="730">promise-utils</text><text x="775" y="240" transform="scale(.1)" textLength="730">promise-utils</text><text x="1345" y="250" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="250">docs</text><text x="1345" y="240" transform="scale(.1)" textLength="250">docs</text></g> </svg>
@@ -0,0 +1,11 @@
const path = require('path');

function main() {
const filename = path.join(__dirname, '../package.json');
var pjson = require(filename);
console.log(pjson.version);
}

if (require.main === module) {
main();
}
@@ -0,0 +1,15 @@
const fs = require('fs');
const path = require('path');
const process = require('process');

function main() {
const currentVersion = process.argv[2];
const filename = path.join(__dirname, '../docs-build/versions.json');
const versions = require(filename);
versions.push(currentVersion);
fs.writeFileSync(filename, JSON.stringify(versions));
}

if (require.main === module) {
main();
}
Oops, something went wrong.

0 comments on commit 25b8c93

Please sign in to comment.
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.