Skip to content

Commit 6813a83

Browse files
Merge pull request #184 from sourcery-ai/tim/feat/readme_updates_for_plan_changes
feat: updated description
2 parents ef7a270 + e7ca09f commit 6813a83

File tree

1 file changed

+8
-20
lines changed

1 file changed

+8
-20
lines changed

README.md

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@
1313

1414
**[WEBSITE](https://sourcery.ai/) | [DOCS](https://docs.sourcery.ai/Welcome/) | [BUGS](https://github.com/sourcery-ai/sourcery/issues)**
1515

16-
Sourcery is the pair programmer who will help you improve your code anytime you're working in Python. It reviews and improves your code automatically so you can spend more time focused on writing new code and less time cleaning things up.
16+
Sourcery is the pair programmer who will help you improve your code. It reviews and improves your code automatically so you can spend more time focused on writing new code and less time cleaning things up.
1717

1818
![Sourcery in VS Code](https://raw.githubusercontent.com/sourcery-ai/sourcery-vscode/main/assets/Sourcery_VS_Code_Example.gif)
1919

2020
---
2121

2222
## Sourcery
2323

24-
Sourcery is a VS Code extension to help make all of your Python code cleaner and more readable. Quickly find areas **where your code could be refactored**, see **instant suggestions for improvement**, and understand how new changes impact your **code quality**.
24+
Sourcery is a VS Code extension to help make all of your code cleaner and more readable. Quickly find areas **where your code could be refactored**, see **instant suggestions for improvement**, and understand how new changes impact your **code quality**.
2525

2626
Here are some of the features Sourcery offers to help improve your code:
2727

@@ -38,6 +38,10 @@ To start using Sourcery on your code, check out our [Getting Started guide](http
3838

3939
Check out our [documentation](https://docs.sourcery.ai/Welcome/) for more information on how to use Sourcery.
4040

41+
Sourcery is free to use for open source projects.
42+
43+
To use Sourcery on non open sourced projects you'll need a Sourcery Pro or Sourcery Team subscription. To get a 14 day free trial to Sourcery Pro, **[sign up for an account on the Sourcery site](https://sourcery.ai/signup/?product=prod_pro&utm_source=VS-Code)**.
44+
4145
---
4246

4347
## Features
@@ -46,7 +50,7 @@ Check out our [documentation](https://docs.sourcery.ai/Welcome/) for more inform
4650

4751
![Refactoring Code with Sourcery](https://raw.githubusercontent.com/sourcery-ai/sourcery-vscode/main/assets/Sourcery_VS_Code_Refactoring.gif)
4852

49-
While you work, Sourcery will review all of the Python files you have open and look for opportunities to clean up and improve your code. Once Sourcery finds a potential improvement it will underline that section of your code.
53+
While you work, Sourcery will review all of the Python, JavaScript, and TypeScript files you have open and look for opportunities to clean up and improve your code. Once Sourcery finds a potential improvement it will underline that section of your code.
5054

5155
Hover your mouse over the underlined section of code to see the changes Sourcery suggests and to see a diff of the proposed change.
5256

@@ -61,7 +65,7 @@ The commands to bring up the quick fix menu depend on your OS & region, but gene
6165
| Windows | Ctrl . |
6266
| Linux | Ctrl . |
6367

64-
Sourcery reviews all of the Python files you have open. You can get an overview of all the suggestions Sourcery has in the Problem window.
68+
Sourcery reviews all of the files you have open. You can get an overview of all the suggestions Sourcery has in the Problem window.
6569

6670
### Set up your own rules - or use public rulesets
6771

@@ -98,8 +102,6 @@ You can use Sourcery to review a single file, a folder, or your whole project at
98102

99103
Right-click on any item in the Explorer window and select "Sourcery → Scan for Refactorings". Sourcery will show you a notification when the scan is done & will show all of the suggestions it found in the Problems window.
100104

101-
Multi-File Analysis requires a Sourcery Pro subscription. To get a month free access to Sourcery Pro, **[sign up for an account on the Sourcery site](https://sourcery.ai/signup/?utm_source=VS-Code)**.
102-
103105
### Duplicate Code Detection
104106

105107
![Duplicate Code Detection in Sourcery](https://raw.githubusercontent.com/sourcery-ai/sourcery-vscode/main/assets/Sourcery_Example_Duplicates_VS_Code.gif)
@@ -110,8 +112,6 @@ Right-click on any item in the Explorer window and select "Sourcery → Detect C
110112

111113
By default, Sourcery will flag items where at least 3 lines are duplicates or near-duplicates that occur at least twice in the scanned files.
112114

113-
Duplicate Code Detection requires a Sourcery Pro subscription. To get a month free access to Sourcery Pro, **[sign up for an account on the Sourcery site](https://sourcery.ai/signup/?utm_source=VS-Code)**.
114-
115115
### Sourcery CLI
116116

117117
If you want to clean up a bigger portion of legacy code, Sourcery CLI comes in handy.
@@ -253,18 +253,6 @@ def func(a,b):
253253
return c
254254
```
255255
256-
---
257-
258-
## Sign Up For More Features
259-
260-
Do you like how Sourcery improves your code bit by bit?
261-
Sign up and get a 30 day free trial of the Pro features. (No automatic renewal, no credit card required.)
262-
263-
After [signing up](https://sourcery.ai/signup/?utm_source=VS-Code), login by
264-
opening the command palette (Ctrl/Cmd+Shift+P) and executing the `Sourcery:
265-
Login` command.
266-
267-
We also love to hear your feedback.
268256
269257
---
270258

0 commit comments

Comments
 (0)