README
socket-sdk
Socket SDK for JavaScript
Usage
npm install socket-sdk
Importing library
You can import the generated bundle to use the whole library generated by this starter:
import SocketClient from 'socket-sdk';
Additionally, you can import the transpiled modules from dist/lib
in case you have a modular library:
import SocketClient from 'socket-sdk/dist/lib/socket-sdk';
API
NPM scripts
npm t
: Run test suitenpm start
: Runnpm run build
in watch modenpm run test:watch
: Run test suite in interactive watch modenpm run test:prod
: Run linting and generate coveragenpm run build
: Generate bundles and typings, create docsnpm run lint
: Lints codenpm run commit
: Commit using conventional commit style (husky will tell you to use it if you haven't :wink:)
Relation
Contributing
- Fork it!
- Create your feature branch: git checkout -b my-new-feature
- Commit your changes: git commit -m 'Add some feature'
- Push to the branch: git push origin my-new-feature
- Submit a pull request :D
License
@1ziton MIT