Skip to content

Commit 06833d0

Browse files
committed
update README to reflect new project name and installation instructions
1 parent 7979379 commit 06833d0

1 file changed

Lines changed: 9 additions & 29 deletions

File tree

README.md

Lines changed: 9 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,21 @@
1-
# Website
1+
# Frank!Framework Docs
22

3-
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
3+
_The official documentation for the Frank!Framework_
44

5-
## Installation
6-
7-
```bash
8-
yarn
9-
```
5+
A centralized resource for all things Frank!Framework, including getting started guides and links to the Manual, API references and more.
106

117
## Local Development
128

13-
```bash
14-
yarn start
15-
```
16-
17-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18-
19-
## Build
20-
21-
```bash
22-
yarn build
23-
```
24-
25-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26-
27-
## Deployment
28-
29-
Using SSH:
9+
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
3010

11+
Install dependencies:
3112
```bash
32-
USE_SSH=true yarn deploy
13+
pnpm
3314
```
3415

35-
Not using SSH:
36-
16+
Start the development server:
3717
```bash
38-
GIT_USER=<Your GitHub username> yarn deploy
18+
pnpm start
3919
```
20+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
4021

41-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

0 commit comments

Comments
 (0)