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

Update 'README.md'

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

9
README.md
View File

@ -6,6 +6,15 @@ In order to instantiate an 100 Ohm resistor, we simply call `new Resistor(100)`.
``` ```
var r1 = new Resistor(100); var r1 = new Resistor(100);
var r2 = new Resistor(150); var r2 = new Resistor(150);
// Combining resistors
var inSeries = r1.series(r2); // type: SeriesResistor var inSeries = r1.series(r2); // type: SeriesResistor
var inParallel = r1.parallel(r2); // type: ParallelResistor var inParallel = r1.parallel(r2); // type: ParallelResistor
// Drawing to DOM
r1.draw(div1);
r2.draw(div2);
inSeries.draw(div3);
inParallel.draw(div4);
``` ```
Calling `Resistor.draw(element)` generates an SVG from the constructed Resistor object. Above code would render something like this:
![Your browser cannot display images :(](imgs/tutorial.png)