Skip to content

Commit 22d9322

Browse files
committed
README.md corrections
More corrections to grammar and spelling in the README.md
1 parent 5a8a0ba commit 22d9322

File tree

1 file changed

+12
-15
lines changed

1 file changed

+12
-15
lines changed

README.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
JSPython is a python-like syntax interpreter implemented with javascript that runs entirely in the web browser and/or in the NodeJS environment.
44

5-
It does not transpile/compile your code into JavaScript, instead, it provides an interactive interpreter that reads Python code and carries out their instructions. With JSPython you should be able to safely use or interact any JavaScript libraries or API with a nice Python language.
5+
It does not transpile/compile your code into JavaScript, instead, it provides an interactive interpreter that reads Python code and carries out their instructions. With JSPython you should be able to safely use or interact with any JavaScript libraries or APIs in a nice Python language.
66

77
```py
88
arr = [4, 9, 16]
@@ -17,24 +17,24 @@ roots = arr.map(sqrt).join(",")
1717
roots = arr.map(i => Math.sqrt(i)).join(",")
1818

1919
```
20-
## Try out JSPython in a wild
20+
## Try out JSPython in the wild
2121
Interactive [Worksheet Systems JSPython editor](https://run.worksheet.systems/data-studio/app/guest/jspy-playground?file=main.jspy) with an ability to query REST APIs and display results in Object Explorer, a configurable Excel-like data grid or just as a JSON or text.
2222

2323
## Why would you use it?
24-
You can easily embed `JSPython` into your web app and your end users will benefit from a Python like scripting facility to:
24+
You can easily embed `JSPython` into your web app and your end users will benefit from a Python-like scripting facility to:
2525
* to build data transformation and data analysis tasks
26-
* allow users to configure a JS objects at run-time
26+
* allow users to configure JS objects at run-time
2727
* run a comprehensive testing scenarios
2828
* experiment with your JS Libraries or features.
29-
* bring a SAFE run time script evaluation functions to your web app
29+
* bring a SAFE run-time script evaluation functions to your web app
3030
* bring Python language to NodeJS environment
3131

3232
## Features
3333
Our aim here is to provide a SAFE Python experience to Javascript or NodeJS users at run-time. So far, we implement a core set of Python feature which should be OK to start coding.
3434

3535
* **Syntax and code flow** Same as Python, In `JSPython` we use indentation to indicate a block of code. All flow features like `if - else`, `for`, `while` loops - along with `break` and `continue`
3636

37-
* **Objects, Arrays** `JSPython` allows you to work with JavaScript objects and arrays and you should be able to invoke their methods and properties as normal. So, all methods including prototype functions `push()`, `pop()`, `splice()` and [any more](https://www.w3schools.com/js/js_array_methods.asp) will work out of box.
37+
* **Objects, Arrays** `JSPython` allows you to work with JavaScript objects and arrays and you should be able to invoke their methods and properties as normal. So, all methods including prototype functions `push()`, `pop()`, `splice()` and [many more](https://www.w3schools.com/js/js_array_methods.asp) will work out of box.
3838

3939
* **JSON** JSPython allows you to work with JSON same way as you would in JavaScript or Python dictionaries
4040

@@ -47,15 +47,15 @@ Our aim here is to provide a SAFE Python experience to Javascript or NodeJS user
4747
* **None, null** `null` and `None` are synonyms and can be used interchangeably
4848

4949
## JSPython distinctive features
50-
Although we haven't implemented all the features available in Python yet. But, we already have a several usefull and distinctive features that are popular in other morden languages, but not in Python:
50+
We haven't implemented all the features available in Python yet. However, we do already have several useful and distinctive features that are popular in other modern languages, but aren't in Python:
5151
- A single line arrow functions `=>` (no lambda keyword required)
52-
- A multiline arrow function `=>`. Particularly usefull when building data transformation pipelines
52+
- A multiline arrow function `=>`. Particularly useful when building data transformation pipelines
5353
- Null conditioning (null-coalescing) `myObj?.property?.subProperty or "N/A"`.
5454

5555
## Quick start
5656

5757
Zero install !
58-
The most simple way to get started, without anything to install, is to use the distribution available online through jsDelivr. You can choose the latest stable release :
58+
The simplest way to get started, without anything to install, is to use the distribution available online through jsDelivr. You can choose the latest stable release :
5959
```
6060
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/jspython-interpreter/dist/jspython-interpreter.min.js">
6161
</script>
@@ -75,7 +75,7 @@ Run JS Python from your Javascript App or web page.
7575
e => console.log("Error => ", error)
7676
)
7777
```
78-
### Or with own data context and custom function:
78+
### Or with your own data context and custom function:
7979
```js
8080
const script = `
8181
x = [1, 2, 3]
@@ -88,15 +88,12 @@ Run JS Python from your Javascript App or web page.
8888
.evaluate(script, context);
8989
// result will be a string "11,12,13"
9090
```
91-
Also, you can provide entire JS Object or even a library.
91+
Also, you can provide an entire JS Object or even a library.
9292

9393
## Run JSPython in a NodeJS with JSPython-CLI
9494

9595
[JSPython-cli](https://github.com/jspython-dev/jspython-cli) is a command line tool what allows you to run JSPython in NodeJS environment
9696

9797

9898
## License
99-
A permissive [BSD 3-Clause License](https://github.com/jspython-dev/jspython/blob/master/LICENSE) (c) FalconSoft Ltd.
100-
101-
102-
lf
99+
A permissive [BSD 3-Clause License](https://github.com/jspython-dev/jspython/blob/master/LICENSE) (c) FalconSoft Ltd.

0 commit comments

Comments
 (0)