Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: update project to build docs #297

Merged
merged 1 commit into from
Dec 14, 2022
Merged

fix: update project to build docs #297

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 3 additions & 9 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
**/node_modules/
**/*.log
test/repo-tests*
**/bundle.js

# Logs
logs
*.log

coverage

# Runtime data
pids
*.pid
Expand All @@ -19,6 +15,7 @@ lib-cov

# Coverage directory used by tools like istanbul
coverage
.coverage

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt
Expand All @@ -28,18 +25,15 @@ coverage

build
docs
.docs

# Dependency directory
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
node_modules

lib
dist
test/test-data/go-ipfs-repo/LOCK
test/test-data/go-ipfs-repo/LOG
test/test-data/go-ipfs-repo/LOG.old

# while testing npm5
package-lock.json
yarn.lock
.nyc_output
.nyc_output
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
- [Usage](#usage)
- [API](#api)
- [Resolvers](#resolvers)
- [API Docs](#api-docs)
- [License](#license)
- [Contribute](#contribute)

Expand Down Expand Up @@ -106,6 +107,10 @@ The available resolvers are:

A resolver receives a `Multiaddr` as a parameter and returns a `Promise<Array<string>>`.

## API Docs

- <https://multiformats.github.io/js-multiaddr>

## License

Licensed under either of
Expand Down
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@
"dep-check": "aegir dep-check",
"build": "aegir build",
"test": "aegir test -f",
"test:chrome": "aegir test -t browser",
"test:chrome": "aegir test -t browser --cov",
"test:chrome-webworker": "aegir test -t webworker",
"test:firefox": "aegir test -t browser -- --browser firefox",
"test:firefox-webworker": "aegir test -t webworker -- --browser firefox",
Expand All @@ -174,7 +174,7 @@
},
"devDependencies": {
"@types/varint": "^6.0.0",
"aegir": "^37.6.2",
"aegir": "^37.7.2",
"sinon": "^15.0.0",
"util": "^0.12.3"
},
Expand Down