Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
jfarcand committed Jan 10, 2024
1 parent 220d881 commit 9c369e1
Showing 1 changed file with 2 additions and 19 deletions.
21 changes: 2 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,10 @@
## Welcome to Atmosphere: The Asynchronous WebSocket/Comet Framework
The Atmosphere Framework contains client and server side components for building Asynchronous Web Applications. The majority of [popular frameworks](https://github.com/Atmosphere/atmosphere/wiki/Atmosphere-PlugIns-and-Extensions) are either supporting Atmosphere or supported natively by the framework. The Atmosphere Framework supports all major [Browsers and Servers](https://github.com/Atmosphere/atmosphere/wiki/Supported-WebServers-and-Browsers)

Atmosphere transparently supports WebSockets, Server Sent Events (SSE), Long-Polling, HTTP Streaming (Forever frame) and JSONP.

* [npm/Node.js client](https://github.com/Atmosphere/atmosphere.js-node)
* [Browser client](https://raw.github.com/Atmosphere/atmosphere-javascript/master/modules/javascript/src/main/webapp/javascript/atmosphere.js)

## Install

### manually
You can get atmosphere.js in several ways. If you use a script tag whose src attribute is set to the below one, browser may not load it because the content type served by raw.github.com is text/plain.

* [atmosphere v3.1.4](https://raw.github.com/Atmosphere/atmosphere-javascript/javascript-project-3.1.4/modules/javascript/src/main/webapp/javascript/atmosphere.js)

Also it is available from the following places, but there may be delays between a release and its availability. We don't manage these ways officially but they are managed by open source community so you can contribute.
* NPM - [atmosphere.js](https://www.npmjs.com/package/atmosphere.js)

### maven
Expand All @@ -22,7 +13,7 @@ Also it is available from the following places, but there may be delays between
<dependency>
<groupId>org.atmosphere.client</groupId>
<artifactId>javascript</artifactId>
<version>3.1.4</version>
<version>4.0.0</version>
</dependency>
```

Expand All @@ -32,12 +23,4 @@ Also it is available from the following places, but there may be delays between
npm install atmosphere.js
```

## Docs
Full API documentation can be read [here](https://github.com/Atmosphere/atmosphere/wiki/atmosphere.js-API) and a lot of samples [here](https://github.com/Atmosphere/atmosphere-samples)

It is recommended to always use the version that matches Atmosphere's runtime.

Latest version may work with lower version, but not officially tested.

### Changelogs
* 3.1.x releases [3.1.0](https://github.com/Atmosphere/atmosphere-javascript/issues?q=is%3Aissue+is%3Aclosed+label%3A3.1.0)
Best way to start with Atmosphere is to use chatGPT and ask for an example!

0 comments on commit 9c369e1

Please sign in to comment.