Skip to content

Commit 349dbf0

Browse files
πŸ“ docs: Add READMEs and update project documentation
- Introduced README.md files for the main project, desktop, and web apps, providing a comprehensive overview, getting started instructions, and features of ScreenLink. - Enhanced visual appeal of READMEs with badges, structured content, and links to the project website. - Removed outdated content and streamlined the setup instructions to improve clarity and user guidance
1 parent b4e99a8 commit 349dbf0

5 files changed

Lines changed: 78 additions & 34 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<div align="center">
2+
<h1 align="center">
3+
<img src="./assets/screenlink.svg" width="100" />
4+
<br>ScreenLink - Open Source Screen Sharing</h1>
5+
<h3>πŸš€ The Open Source Alternative to Loom</h3>
6+
<h3>🌐 Available on MacOS, Windows, & Linux</h3>
7+
<h3>πŸ”— Get started at <a href="https://screenlink.io">ScreenLink.io</a></h3>
8+
9+
<p>This repository contains two main projects:</p>
10+
<ul>
11+
<li><b>Desktop Application:</b> <code>apps/desktop</code></li>
12+
<li><b>Web Platform:</b> <code>apps/web</code></li>
13+
</ul>
14+
15+
</div>

β€Žapps/desktop/README.mdβ€Ž

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22
<h1 align="center">
33
<img src="./src/assets/screenlink.svg" width="100" />
44
<br>ScreenLink Desktop</h1>
5-
<h3>β—¦ ScreenLink is the Open Source Loom Alternative.</h3>
6-
<h3>β—¦ Link Your World, Expand Your Screen!</h3>
5+
76

87
<p align="center">
98
<img src="https://img.shields.io/badge/electronbuilder-FFFFFF.svg?style=flat-square&logo=electron-builder&logoColor=black" alt="electronbuilder" />
@@ -40,7 +39,6 @@
4039
- [πŸ€– Running screenlink-desktop](#-running-screenlink-desktop)
4140
- [🀝 Contributing](#-contributing)
4241
- [*Contributing Guidelines*](#contributing-guidelines)
43-
- [πŸ“„ License](#-license)
4442

4543
---
4644

@@ -51,8 +49,6 @@ ScreenLink is the Open Source Loom Alternative. Get started at [ScreenLink.io](h
5149

5250
Screenlink Desktop is an Electron-based desktop application that offers user-friendly screen and webcam recording capabilities. The application provides device code retrieval, updates management, permissions handling, screen recording, webcam handling, and selection of audio and camera sources. Users can additionally manage audio and camera settings conveniently within the app. Written in TypeScript and employing React JS for the frontend, it features efficient linting with ESLint, and uses PostCSS and Tailwind CSS for polished presentation and interactivity, making it a feature-packed solution for screen recording needs.
5351

54-
There is a NextJS web and API Github that manages user accounts, video uploads and the landing page available here: [screenlink-web](https://github.com/mangledbottles/screenlink-web)
55-
5652
---
5753

5854
## πŸ“¦ Features
@@ -148,12 +144,12 @@ There is a NextJS web and API Github that manages user accounts, video uploads a
148144

149145
1. Clone the screenlink-desktop repository:
150146
```sh
151-
git clone https://github.com/mangledbottles/screenlink-desktop
147+
git clone https://github.com/mangledbottles/screenlink
152148
```
153149

154150
2. Change to the project directory:
155151
```sh
156-
cd screenlink-desktop
152+
cd screenlink/apps/desktop
157153
```
158154

159155
3. Install the dependencies:
@@ -212,11 +208,4 @@ Once your PR is reviewed and approved, it will be merged into the main branch.
212208

213209
</details>
214210

215-
---
216-
217-
## πŸ“„ License
218-
219-
220-
This project is protected under the [SELECT-A-LICENSE](https://choosealicense.com/licenses) License. For more details, refer to the [LICENSE](https://choosealicense.com/licenses/) file.
221-
222211
---

β€Žapps/web/README.mdβ€Ž

Lines changed: 59 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,77 @@
1-
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
1+
<div align="center">
2+
<h1 align="center">
3+
<img src="./public/assets/screenlink.svg" width="100" />
4+
<br>ScreenLink Web</h1>
25

3-
## Getting Started
6+
<p align="center">
7+
<img src="https://img.shields.io/badge/Next.js-000000.svg?style=flat-square&logo=Next.js&logoColor=white" alt="Next.js" />
8+
<img src="https://img.shields.io/badge/React-61DAFB.svg?style=flat-square&logo=React&logoColor=black" alt="React" />
9+
<img src="https://img.shields.io/badge/TypeScript-3178C6.svg?style=flat-square&logo=TypeScript&logoColor=white" alt="TypeScript" />
10+
<img src="https://img.shields.io/badge/Tailwind_CSS-38B2AC.svg?style=flat-square&logo=Tailwind-CSS&logoColor=white" alt="Tailwind CSS" />
11+
<img src="https://img.shields.io/badge/Vercel-000000.svg?style=flat-square&logo=Vercel&logoColor=white" alt="Vercel" />
12+
</p>
413

5-
First, run the development server:
14+
<p align="center">
15+
<a href="https://screenlink.io">Visit ScreenLink.io</a>
16+
</p>
617

18+
</div>
19+
20+
---
21+
22+
## πŸ“– Table of Contents
23+
24+
- [πŸ“– Table of Contents](#-table-of-contents)
25+
- [πŸ“ Overview](#-overview)
26+
- [πŸš€ Getting Started](#-getting-started)
27+
- [πŸ”§ Installation](#-installation)
28+
- [πŸ“¦ Features](#-features)
29+
- [🀝 Contributing](#-contributing)
30+
31+
---
32+
33+
## πŸ“ Overview
34+
35+
ScreenLink Web is the web platform for ScreenLink, the open-source alternative to Loom for screen recording. It manages user accounts, video uploads, and serves as the landing page for new users. Built with Next.js, it leverages the best of React and server-side rendering for a fast and seamless user experience.
36+
37+
---
38+
39+
## πŸš€ Getting Started
40+
41+
To run the development server:
742
```bash
8-
npm run dev
9-
# or
1043
yarn dev
11-
# or
12-
pnpm dev
1344
```
1445

15-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
1646

17-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
47+
Visit [http://localhost:3000](http://localhost:3000) to view the application.
1848

19-
[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
49+
## πŸ”§ Installation
2050

21-
The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
51+
1. Clone the repository:
52+
```bash
53+
git clone https://github.com/mangledbottles/screenlink
54+
```
2255

23-
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
2456

25-
## Learn More
57+
2. Install dependencies:
58+
```bash
59+
cd screenlink/apps/web && yarn
60+
```
61+
2662

27-
To learn more about Next.js, take a look at the following resources:
63+
3. Start the development server:
64+
```bash
65+
yarn dev
66+
```
2867

29-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
30-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
3168

32-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
69+
## πŸ“¦ Features
3370

34-
## Deploy on Vercel
71+
- **User Account Management:** Sign up, sign in, and manage user profiles.
72+
- **Video Uploads:** Upload and manage screen recordings.
73+
- **Landing Page:** Informational landing page for new users.
3574

36-
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
75+
## 🀝 Contributing
3776

38-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
77+
Contributions are welcome! Check out the [issues](https://github.com/mangledbottles/screenlink-web/issues) or submit a pull request.

β€Žassets/screenlink.pngβ€Ž

25.4 KB
Loading

β€Žassets/screenlink.svgβ€Ž

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
Β (0)