Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hsvikum authored Dec 1, 2023
1 parent 562e6b8 commit 8354c02
Showing 1 changed file with 10 additions and 37 deletions.
47 changes: 10 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,14 @@
# Website
# Privacy at 99x

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
99X is a company that specialized in building software products and platforms. During the last decade, we have gathered immense knowledge and experience in architecting software products and platforms. This knowledge base is an attempt to share such learning for the benefit of the community.

### Installation
## Who can contribute?
We warmly welcome any contributions for both Xians and anyone outside 99X (for improvements).

```
$ yarn
```
## How to contribute?
- You can directly edit each page via the portal.
- After proposing the changes, send a Pull Request to the repository.
- We will review your changes and update content accordingly.

### Local Development

```
$ yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
```

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

### Deployment

Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```

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.
## For Everyone
If you see any improvement in the content or you can also raise an issue using GitHub or send the Pull request with sufficient details of the improvement you made.

0 comments on commit 8354c02

Please sign in to comment.