Skip to content

Update README #1285

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.

Sign up for GitHub

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

Closed
lnieuwenhuis wants to merge 2 commits into from
+1 −58
Closed

Update README #1285

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5d569cd
Update README
lnieuwenhuis May 18, 2026
0be768e
Update README
lnieuwenhuis May 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 1 addition & 58 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,58 +1 @@
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/pingdotgg/uploadthing/main/assets/uploadthing-logo-dark-background.svg">
<img src="https://github.com/pingdotgg/uploadthing/blob/main/assets/uploadthing-logo-light-background.svg" width="480" height="80" alt="Logo for UploadThing">
</picture>
</p>

<p align="center">
A thing for uploading files.
</p>

<div align="center">
<a href="https://uploadthing.com">Home</a> | <a href="https://docs.uploadthing.com">Docs</a> | <a href="https://t3-tools.notion.site/776334c06d814dd08d450975bb983085">Roadmap</a>
</div>

## Table of Contents

This repository contains the packages, docs and examples for uploadthing

- [Next.js App Directory](https://github.com/pingdotgg/uploadthing/tree/main/examples/minimal-appdir) -
A simple example using the Next.js app directory
- [Next.js Pages Directory](https://github.com/pingdotgg/uploadthing/tree/main/examples/minimal-pagedir) -
A simple example using the Next.js pages directory
- [SolidStart SSR](https://github.com/pingdotgg/uploadthing/tree/main/examples/minimal-solidstart) -
A simple example using SSR with SolidStart
- [Docs Site](https://github.com/pingdotgg/uploadthing/tree/main/docs) - Source
for docs.uploadthing.com
- [React Package](https://github.com/pingdotgg/uploadthing/tree/main/packages/react) -
_@uploadthing/react_ - the components and hooks for using uploadthing in your
React projects
- [Solid Package](https://github.com/pingdotgg/uploadthing/tree/main/packages/solid) -
_@uploadthing/solid_ - the components and hooks for using uploadthing in your
Solid projects
- [uploadthing](https://github.com/pingdotgg/uploadthing/tree/main/packages/uploadthing) -
server/client stuff (framework agnostic)

[Report an Issue](https://github.com/pingdotgg/uploadthing/issues/new)

## Contributing

All UploadThing SDKs are open source and we welcome contributions from the
community.

<!-- prettier-ignore -->
> [!NOTE]
> If your change also requires infrastructure changes, please reach out
> and we can work together to make the necessary changes on our end.

<!-- prettier-ignore-end -->

1. Fork and clone the repository
2. Ensure you have the LTS version of Node.js installed, as well as the latest
version of [pnpm](https://pnpm.io).
3. Install the project dependencies by running `pnpm install`.
4. Implement your changes, as well as any documentation or tests that are
required.
5. Create a changeset for your changes by running `pnpm changeset`.
6. Open a pull request with your changes and changeset.
lnieuwenhuis

@greptile-apps greptile-apps Bot May 18, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P0 Entire README replaced with username

This change deletes all content from the README — the logo, project description, navigation links, package listing, contributing guide, and issue reporting link — and replaces it with just the author's username lnieuwenhuis. This appears to be a test commit rather than an intentional documentation update, and it would leave the repository with no useful landing page.

Prompt To Fix With AI 
This is a comment left during a code review.
Path: README.md
Line: 1

Comment:
**Entire README replaced with username**

This change deletes all content from the README — the logo, project description, navigation links, package listing, contributing guide, and issue reporting link — and replaces it with just the author's username `lnieuwenhuis`. This appears to be a test commit rather than an intentional documentation update, and it would leave the repository with no useful landing page.

How can I resolve this? If you propose a fix, please make it concise.

@coderabbitai coderabbitai Bot May 18, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Restore a meaningful README opening section.

At Line 1, the README now contains only lnieuwenhuis, which removes project title/context and effectively breaks first-time onboarding from the repository landing page. Please replace this with a proper heading/introduction (or restore the previous header block).

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` at line 1, The README currently contains only the stray string
"lnieuwenhuis"; replace that line with a meaningful project header and intro
paragraph. Edit README.md to restore a top-level title (e.g., "# ProjectName"),
a one-sentence description of purpose, and a short onboarding pointer
(badges/links or "Getting Started" section) so the repo landing page is
informative — ensure you remove the lone "lnieuwenhuis" string and commit the
restored header block.

Loading