kevinlu1248 commited on
Commit
1f458f2
Β·
1 Parent(s): 0d9d86e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +35 -3
README.md CHANGED
@@ -1,10 +1,42 @@
1
  ---
2
  title: README
3
  emoji: 🐠
4
- colorFrom: blue
5
- colorTo: green
6
  sdk: static
7
  pinned: false
8
  ---
9
 
10
- Edit this `README.md` markdown file to author your organization card.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  title: README
3
  emoji: 🐠
4
+ colorFrom: grey
5
+ colorTo: purple
6
  sdk: static
7
  pinned: false
8
  ---
9
 
10
+ <p align="center">
11
+ <img src="https://github.com/sweepai/sweep/assets/26889185/39d500fc-9276-402c-9ec7-3e61f57ad233">
12
+ </p>
13
+ <p align="center">
14
+ <i>Bug Reports & Feature Requests ⟢&nbsp; Code Changes</i>
15
+ </p>
16
+
17
+ <b>Sweep</b> is an AI junior developer that transforms bug reports & feature requests into code changes.
18
+
19
+ Describe bugs, small features, and refactors like you would to a junior developer, and Sweep:
20
+ 1. πŸ” reads your codebase
21
+ 2. πŸ“ plans the changes
22
+ 3. ⚑**writes a pull request with code**⚑
23
+
24
+ ### Features 🌠
25
+
26
+ * 🌠 Turns issues directly into pull requests (without an IDE)
27
+ * πŸ‘€ Addresses developer replies & comments on its PRs
28
+ * πŸ”Ž Uses embedding-based code search
29
+
30
+ ## Getting Started πŸš€
31
+
32
+ Install Sweep by adding the [**Sweep GitHub app**](https://github.com/apps/sweep-ai) to your desired repositories.
33
+
34
+ For more details, visit our [✨ Installation](docs/installation.md) page if it doesn't automatically bring you there.
35
+
36
+ ## Limitations of Sweep ⚠️
37
+
38
+ * πŸ—οΈ **Large-scale refactors**: >3 files or >150 lines of code changes (we're working on this!)
39
+ * e.g. Refactor the entire codebase from Tensorflow to PyTorch
40
+
41
+ * πŸ–ΌοΈ **Editing images** and other non-text assets
42
+ * e.g. Use the logo to create favicons for our landing page