Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #1210

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
70 changes: 67 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,56 @@
<p align="center">
<img src="https://getkap.co/static/favicon/kap.svg" height="64">
<h3 align="center">Kap</h3>
<p align="center">An open-source screen recorder built with web technology<p>
<p align="center">An open-source screen recorder built with web technology
This software could be used for a variety of tasks. This can used for
teachers and educators to record a lesson or a virtual whiteboard to teach
students lessons. This screen recorder can also be used for content purposes;
for example, content creators and gamers can use the software to record tutorials,
share highlights, or just for personal entertainment. I plan to implement features
in the future where we use it so people and content creators can use the software
to give live footage of what they see, like games or other content like movies
and videos.
<p>
<p align="center"><a href="https://circleci.com/gh/wulkano/kap"><img src="https://circleci.com/gh/wulkano/Kap.svg?style=shield" alt="Build Status"></a> <a href="https://github.com/sindresorhus/xo"><img src="https://img.shields.io/badge/code_style-XO-5ed9c7.svg" alt="XO code style"></a></p>
</p>

[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine/)

## Get Kap
## Table of Contents

Download the latest release:
Get Kap

How To Use Kap

Contribute

Plugins

Dev Builds

Related Repositories

Functions

Newsletter

License

Privacy

## Installation Instruction for Kap

Download the latest release:
- [Apple silicon](https://getkap.co/api/download/arm64)
Download the latest .dmg file from the list of releases.
Double-click the downloaded .dmg file to mount the disk image.
Drag the Kap application icon to the Applications folder.
Eject the mounted disk image.
- [Intel](https://getkap.co/api/download/x64)
Download the latest .exe installer from the list of releases.
Double-click the downloaded .exe file to start the installation process.
Follow the on-screen instructions in the installer to complete the installation.
Once installed, you can launch Kap from the Start menu or desktop shortcut.

Or install with [Homebrew-Cask](https://caskroom.github.io):

Expand All @@ -26,6 +64,24 @@ Click the menu bar icon to bring up the screen recorder. After selecting what po

> Tip: While recording, Option-click the menu bar icon to pause or right-click for more options.

## Functions

Capture Area Selection: This allows you to select what part of the screen you want to screen record.

Audio Recording: Allows you to record audio output.

Video Recording: Allows you to record video output with or without audio.

Live Streaming: Allows you to live stream your screen.

Cursor Effects: Allows you to add effect to the cursor when screen recorded. Like putting a red circle around the mouse or giving it a trail to make it more visible.

Video Editing: Basic tools for video editing, like cutting, merging, and trimming clips.

Privacy Controls: Options to blur or mask sensitive information, such as passwords or personal data, during recording to protect user privacy and confidentiality.

Integration with External Devices: Compatibility with external devices, such as cameras, microphones, or external monitors, to enhance recording quality or expand recording capabilities.

## Contribute

Read the [contribution guide](contributing.md).
Expand All @@ -47,6 +103,14 @@ Download [`main`](https://kap-artifacts.now.sh/main) or builds for any other bra

[Subscribe](http://eepurl.com/ch90_1)

## License

For more info on the License, read [plugins docs](docs/LICSENSE.md)

## Privacy

For more info on the License, read [plugins docs](docs/PRIVACY.md)

## Thanks

- [▲ Vercel](https://vercel.com/) for fast deployments served from the edge, hosting our website, downloads, and updates.
Expand Down