Merge pull request #11 from byjg/claude/audit-docs-sidebar-position-011CV2tCp1udEQGEvR4Uvrd4

Audit and organize Docusaurus documentation structure

Author: byjg

README.md

@@ -7,233 +7,93 @@
 [![GitHub release](https://img.shields.io/github/release/byjg/jquery-sse.svg)](https://github.com/byjg/jquery-sse/releases/)
 [![](https://data.jsdelivr.com/v1/package/npm/jquery-sse/badge)](https://www.jsdelivr.com/package/npm/jquery-sse)
 
-A lightweigth jQuery Plugin for Server-Sent Events (SSE) EventSource Polyfill. 
-This plugin try to use the native EventSource object if it supported by the browser.
-If there is no native support the request is made by ajax requests (polling).
+A lightweight jQuery Plugin for Server-Sent Events (SSE) EventSource Polyfill.
+This plugin tries to use the native EventSource object if it's supported by the browser.
+If there is no native support, the request is made by Ajax requests (polling).
 You do not need to change the server side nor the client side.
 
-*If you are looking for a SSE Polyfill library without jQuery dependency
+*If you are looking for an SSE Polyfill library without jQuery dependency
 try [yaj-sse](https://github.com/byjg/yaj-sse). The yaj-sse is a port
 from version 0.1.4 of jQuery SSE.*
 
-## Example
+## Quick Start
 
-Client Side
+### Client Side
 
 ```javascript
 var sse = $.SSE('http://example.com/sse-server.php', {
-    onMessage: function(e){ 
-        console.log("Message"); console.log(e); 
+    onMessage: function(e){
+        console.log("Message"); console.log(e);
     }
 });
 sse.start();
 ```
 
-Server Side
+### Server Side
 
 ```php
 echo "data: My Message\n";
 echo "\n";
 ```
 
-## Dependencies
+## Documentation
 
-* jQuery
+For comprehensive documentation, please refer to the following guides:
 
-## Install
+1. **[Getting Started](docs/getting-started.md)** - Installation, dependencies, and quick start guide
+2. **[Usage](docs/usage.md)** - Constructor, methods (start, stop), and basic usage
+3. **[Configuration](docs/configuration.md)** - Event callbacks, options, headers, and custom events
+4. **[Examples](docs/examples.md)** - Code examples for common use cases and running examples locally
+5. **[Known Limitations and Quirks](docs/quirks.md)** - Browser compatibility, Ajax fallback limitations, and debugging tips
+6. **[API Reference](docs/api-reference.md)** - Complete API documentation with all methods and properties
+7. **[References and Resources](docs/references.md)** - External resources, specifications, and related projects
 
-Just download the repository and point to the jQuery plugin:
+## Features
 
-```html
-<script src="jquery.sse.js" ></script>
-```
+- Automatic detection and use of native EventSource when available
+- Seamless fallback to Ajax polling when EventSource is not supported
+- Support for custom events
+- Custom HTTP headers support (automatically uses Ajax mode)
+- Automatic reconnection with configurable retry intervals
+- Event IDs and Last-Event-ID tracking
+- Simple jQuery-style API
+
+## Installation
 
-or
+### Direct Download
 
 ```html
-<script src="jquery.sse.min.js" ></script>
+<script src="jquery.sse.min.js"></script>
 ```
 
-You can also install using bower:
+### Bower
 
 ```bash
 bower install jquery-sse
 ```
 
-## Usage:
-
-### Constructor
-
-```
-var sse = $.SSE(url, settings);
-```
-
-* url: URL for the server will be sent the events to this page;
-* settings: The events and options for the SSE instance
-
-### Settings List
-
-All the options:
-
-```
-var sseObject = $.SSE('sse-server.php', {
-    onOpen: function (e) {},
-    onEnd: function (e) {},
-    onError: function (e) {},
-    onMessage: function (e) {},
-    options: {},
-    headers: {},
-    events: {}
-});
-```
-
-**Event onOpen**
-
-Fired when the connection is opened the first time;
-
-```javascript
-onOpen: function(e){ 
-    console.log("Open"); console.log(e); 
-},
-```
-
-**Event onEnd**
-
-Fired when the connection is closed and the client will not listen for the server events;
-
-```javascript
-onEnd: function(e){ 
-    console.log("End"); console.log(e); 
-},
-```
-
-**Event onError**
-
-Fired when the connection error occurs;
-
-```javascript
-onError: function(e){ 
-    console.log("Could not connect"); 
-},
-```
-
-**Event onMessage**
-
-Fired when the a message without event is received
-
-```javascript
-onMessage: function(e){ 
-    console.log("Message"); console.log(e); 
-},
-```
-
-**Custom Options**
-
-Define the options for the SSE instance
-
-```javascript
-options: {
-    forceAjax: false
-},
-```
-
-* **forceAjax**: Uses ajax even if the EventSource object is supported natively;
-
-
-**Custom Events**
-
-Fired when the server set the event and match with the key
-
-For example, if you have a custom event called `myEvent` you may use the follow code:
+### jsDelivr CDN
 
-```javascript
-events: {
-    myEvent: function(e) {
-        console.log('Custom Event');
-        console.log(e);
-    }
-}
-```
-
-Server side:
-
-```php
-echo "event: myEvent\n";   // Must match with events in the HTML.
-echo "data: My Message\n";
-echo "\n";
-```
-
-**Custom Headers**
-
-You can send custom headers to the request.
-
-```javascript
-headers: {
-    'Authorization': 'Bearer 1a234fd4983d'
-}
-```
-
-Note: As the EventSource does not support send custom headers to the request,
-the object will fallback automatically to 'forceAjax=true', even this it is not set.
-
-
-## Methods
-
-**start**
-
-Start the EventSource communication
-
-```javascript
-sse.start();
-```
-
-**stop**
-
-Stop the EventSource communication
-
-```javascript
-sse.stop();
-```
-
-
-## Quirks
-
-The ajax does not support the streaming as the event source supports. In that case we recommend
-create a server without streaming and set the "retry" to determine query frequency;
-
-Example Server Side:
-
-```php
-echo "retry: 3000\n";
-echo "data: My Message\n";
-echo "\n";
-```
-
-## Minify
-
-```
-apt install uglifyjs
-
-uglifyjs --compress 'drop_console,drop_debugger' --mangle -r '$,require,exports,_' -o jquery.sse.min.js jquery.sse.js
+```html
+<script src="https://cdn.jsdelivr.net/npm/jquery-sse@latest/jquery.sse.min.js"></script>
 ```
 
-## Running the examples
+## Browser Support
 
-Start the webserver:
+- ✅ Chrome 6+
+- ✅ Firefox 6+
+- ✅ Safari 5+
+- ✅ Opera 11+
+- ✅ Edge 79+
+- ❌ Internet Explorer (uses Ajax fallback automatically)
 
-```shell
-docker run -it --rm -p 8080:80 -v $PWD:/var/www/html byjg/php:7.4-fpm-nginx 
-```
+## Contributing
 
-Open the browser:
-http://localhost:8080/examples/sse-client.html
+Contributions are welcome! Please feel free to submit pull requests or open issues on GitHub.
 
-## References
+## License
 
-* http://www.w3.org/TR/2009/WD-eventsource-20091029/
-* https://developer.mozilla.org/en-US/docs/Server-sent_events/Using_server-sent_events
-* http://html5doctor.com/server-sent-events/
-* http://www.html5rocks.com/en/tutorials/eventsource/basics/
+This project is licensed under the MIT License. See the [LICENSE](https://opensource.byjg.com/opensource/licensing.html) file for details.
 
 ----
 [Open source ByJG](http://opensource.byjg.com)