dominic/ResistorJS
1
0
Fork 0
Code Issues 1 Pull Requests Releases Wiki Activity

Add 'README.md'

Browse Source
This commit is contained in:
dominic 2020-11-18 17:44:56 +01:00
parent c44be9ec68
commit 27f1586eb4
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md Normal file
View File

@ -0,0 +1,11 @@
# ResistorJS
ResistorJS is a Javascript library intended to compose electronical resistors.
## Using Resistors in Code
In order to instantiate an 100 Ohm resistor, we simply call `new Resistor(100)`. In order to compose several resistors, the composite resistor types `SeriesResistor` and `ParallelResistor` are available.
```
var r1 = new Resistor(100);
var r2 = new Resistor(150);
var inSeries = r1.series(r2); // type: SeriesResistor
var inParallel = r1.parallel(r2); // type: ParallelResistor
```