Skip to content

Commit dd1a5d3

Browse files
committed
docs: updating README page
Signed-off-by: Pawel Psztyc <[email protected]>
1 parent 96462bb commit dd1a5d3

File tree

1 file changed

+22
-4
lines changed

1 file changed

+22
-4
lines changed

README.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,30 @@
11
# Advanced REST Client application
22

3-
This is the main repository for the ARC Electron application
3+
This is the main repository for the ARC Electron application.
44

5-
Tis is work in progress.
5+
## Documentation
66

7-
To try this version of the application:
7+
If you are looking for the **documentation** then visit [docs.advancedrestclient.com](https://docs.advancedrestclient.com/).
88

9-
Cone the repository:
9+
## Installation
10+
11+
If you are looking to install the application, the go to [the releases page](https://github.com/advanced-rest-client/arc-electron/releases) and download the installer for your system.
12+
13+
1. Find the latest stable release.
14+
2. Toggle the `Assets` and find the installer for your system. For Windows it will be `arc-setup.exe`. macOS users should download `arc-x.x.x.dmg`, where `x.x.x` is the version number. Linux users should find the distribution corresponding to the system you are using.
15+
3. Run the installer by clicking on it.
16+
17+
Note that you may be asked to use an account with upgraded privileges to install the application.
18+
19+
## Project planning
20+
21+
We believe in open web and open API tooling. The project is managed in an open way and you can also contribute by requesting features and reporting issues. You can check current planning in the [project plan](https://github.com/orgs/advanced-rest-client/projects/2).
22+
23+
## Contributing to the project
24+
25+
Get familiar with the [application architecture](https://app.gitbook.com/@api-components/s/arc/arc-development/architecture). You may also want to look into the `.github/CONTRIBUTING.md` document before you jump into the development.
26+
27+
Clone the repository:
1028

1129
```sh
1230
git clone https://github.com/advanced-rest-client/arc-electron.git

0 commit comments

Comments
 (0)