diff --git a/README.md b/README.md new file mode 100644 index 00000000..457658b2 --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# socket.io + +[![Latest NPM version](https://img.shields.io/npm/v/socket.io.svg)](https://www.npmjs.com/package/socket.io) +[![Build status](https://github.com/socketio/socket.io/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/socketio/socket.io/actions/workflows/ci.yml) +[![Downloads per month](https://img.shields.io/npm/dm/socket.io.svg)]((https://www.npmjs.com/package/socket.io)) + +## Getting Started + +Please check our documentation [here](https://socket.io). + +## Questions + +Our [issues list](https://github.com/socketio/socket.io/issues) is exclusively reserved for bug reports and feature requests. For usage questions, please use the following resources: + +- read our [documentation](https://socket.io/docs/v4/) +- check our [troubleshooting guide](https://socket.io/docs/v4/troubleshooting-connection-issues/) +- look for/ask questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/socket.io) +- create a new [discussion](https://github.com/socketio/socket.io/discussions/new?category=q-a) + +## Security + +If you think that you have found a security vulnerability in our project, please do not create an issue in this GitHub repository, but rather refer to our [Security Policy](./SECURITY.md). + +## Issues and contribution + +Please make sure to read our [Contributing Guide](./CONTRIBUTING.md) before creating an issue or making a pull request. + +Thanks to everyone who has already contributed to Socket.IO! + + + +## License + +[MIT](https://opensource.org/licenses/MIT)