From aabb5292acf87781a91b384a9453072031e2c693 Mon Sep 17 00:00:00 2001 From: Nafiz Chawdhury <98878310+NafizChaw@users.noreply.github.com> Date: Wed, 25 Sep 2024 20:21:59 -0400 Subject: [PATCH 1/2] Update README.md --- README.md | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c86de66..dc40817 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,14 @@ Repository for the [Kap] website, built with [Next.js](https://github.com/zeit/next.js) and powered by [Vercel](https://vercel.com) +## Table of Contents +1. [Development](#development) + - [Requirements](#requirements) + - [Making Changes](#making-changes) +2. [Related Repositories](#related-repositories) +3. [Newsletter](#newsletter) +4. [FAQ](#faq) + ## Development ### Requirements @@ -24,7 +32,21 @@ Run `npm run dev` or `yarn dev` to start the website in dev mode. [Subscribe for updates](http://eepurl.com/ch90_1). +## FAQ + +### 1. What is Kap? +Kap is an open-source screen recording app built for macOS. This repository is specifically for its website. + +### 2. How do I install and run the website locally? +To run the website locally: +1. Clone the repository and install the required node packages using `npm install` or `yarn`. +2. Run `npm run dev` or `yarn dev` to launch the website in development mode. + +### 3. Can I contribute to the website's development? +Yes! You can contribute by forking the repository, making your changes, and submitting a pull request. + +### 4. What technologies are used for this website? +The Kap website is built using [Next.js](https://nextjs.org/) and powered by [Vercel](https://vercel.com), a platform for deploying Next.js applications. -[Kap]: https://getkap.co -[node.js]: https://nodejs.org -[fork]: https://help.github.com/articles/fork-a-repo/ +### 5. Where can I find the code for the Kap app itself? +You can find the code for the Kap screen recording app in [this repository](https://github.com/wulkano/kap). From adfa76cf13853b1053a4201e921b89620972c43a Mon Sep 17 00:00:00 2001 From: Nafiz Chawdhury <98878310+NafizChaw@users.noreply.github.com> Date: Wed, 25 Sep 2024 20:32:17 -0400 Subject: [PATCH 2/2] Update README.md Implement and faq section and table of content --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dc40817..bc395cc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # getkap.co (Kap Website) -Repository for the [Kap] website, built with [Next.js](https://github.com/zeit/next.js) and powered by [Vercel](https://vercel.com) +Repository for the [Kap] website, built with [Next.js](https://github.com/zeit/next.js) and powered by [Vercel](https://vercel.com). + +## Introduction +Kap is a free and open-source screen recording application designed for macOS. This repository contains the source code for the official Kap website, which showcases the features of the app, provides download links, and offers support and resources for users and contributors. The website is built using Next.js and powered by Vercel. ## Table of Contents 1. [Development](#development) @@ -9,13 +12,15 @@ Repository for the [Kap] website, built with [Next.js](https://github.com/zeit/n 2. [Related Repositories](#related-repositories) 3. [Newsletter](#newsletter) 4. [FAQ](#faq) +5. [How to Get Help](#how-to-get-help) +6. [License](#license) ## Development ### Requirements 1. Have [node.js] installed 2. [Fork] and clone the repository to your machine -3. `yarn` or `npm install` to install the relevant node packages +3. Run `yarn` or `npm install` to install the relevant node packages ### Making changes @@ -50,3 +55,16 @@ The Kap website is built using [Next.js](https://nextjs.org/) and powered by [Ve ### 5. Where can I find the code for the Kap app itself? You can find the code for the Kap screen recording app in [this repository](https://github.com/wulkano/kap). + +## How to Get Help +If you run into any issues or have questions, there are several ways to get help: +- Open a [GitHub Issue](https://github.com/wulkano/kap/issues). +- Visit our [community forum](https://getkap.co/community) for discussion and support. +- Check out the official [Kap Documentation](https://getkap.co/docs). + +## License +This project is licensed under the MIT License. See the [LICENSE](https://github.com/wulkano/kap/blob/main/LICENSE) file for details. + +[Kap]: https://getkap.co +[node.js]: https://nodejs.org +[fork]: https://help.github.com/articles/fork-a-repo/