Skip to content

Commit d931cc1

Browse files
authored
Merge pull request #2506 from Dishpit/fix/documentation
Add a Proper Getting Started Section
2 parents 88adabc + f9c72a6 commit d931cc1

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

+22-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,28 @@ Support for Jakarta EE (`jakarta.*`) is available with Atmosphere 3.0.0
3939
atmosphere-module can be: runtime (main module), jersey, spring, kafka, guice, redis, hazelcast, jms, rabbitmq, jgroups etc. Our official releases are available from Maven Central [download](http://search.maven.org/#search|ga|1|atmosphere).
4040

4141
### Getting started
42-
Best way is to use OpenAI ChatGPT for getting started with Atmosphere. For example, you can ask `How to build at Atmosphere framework websockets application. Use Typescript for the frontend`. Get also started using this step by step [tutorial](http://async-io.org/tutorial.html).
42+
Here's how to get your first Atmosphere project off the ground.
43+
44+
#### Prerequisites
45+
Ensure you have Java 8 (or later) installed on your system. For managing your Java Project and its dependencies, you'll need a build automation tool. We recommend [Maven](https://maven.apache.org/), which is widely used in the Java ecosystem.
46+
47+
#### Project Setup
48+
Create a new project using Maven. Add Atmosphere as a dependency in your `pom.xml` to access all the necessary libraries.
49+
50+
#### Server Configuration
51+
In your project, you'll define a server endpoint that listens to incoming connections. Atmosphere's annotations and resource handlers make this process straightforward.
52+
53+
#### Running Your Server
54+
55+
With the server set up, use your IDE or the Maven CLI to compile and run your application.
56+
57+
#### Create a Client
58+
Your web client will need to establish a connection to your server. You can create a simple HTML page with JavaScript to connect and communicate with your server endpoint.
59+
60+
#### Keep Going!
61+
Once you've got the basics down, explore the full range of Atmosphere's capabilities to create more sophisticated real-time applications.
62+
63+
For detailed instructions, examples, and advanced configurations, refer to the [official Atmosphere tutorial](https://www.async-io.org/tutorial.html).
4364

4465
### Official Documentation
4566
Complete repository of samples [sample](https://github.com/Atmosphere/atmosphere-samples/).

0 commit comments

Comments
 (0)