Skip to content

Commit c86beb3

Browse files
committed
Update readme
1 parent 0645169 commit c86beb3

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
# Website
1+
# FreeSWITCH Documentation
22

3-
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
3+
This repository contains the documentation for FreeSWITCH, published at https://developer.signalwire.com/freeswitch.
44

5+
## Instructions for contributors
56
### Installation
67

78
```
@@ -24,11 +25,11 @@ $ yarn build
2425

2526
This command generates static content into the `build` directory and can be served using any static contents hosting service.
2627

27-
### Deployment
28-
29-
Docker:
28+
### Building the Docker image
3029

3130
```
3231
$ docker build -t freeswitch-docs .
3332
$ docker run --rm -it -p 8080:80 freeswitch-docs
3433
```
34+
35+
The site will be available on port 8080 on your local machine.

0 commit comments

Comments
 (0)