diff --git a/README.md b/README.md index aaba2fa..1c2ab24 100644 --- a/README.md +++ b/README.md @@ -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= 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.