Skip to content

Commit f70363c

Browse files
Merge pull request #29 from jaredpetersen/feature-refresh-dependencies-and-docs
refresh dependencies and docs
2 parents e1b8c81 + 1dcaf64 commit f70363c

File tree

5 files changed

+13820
-9233
lines changed

5 files changed

+13820
-9233
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
# testing
77
/coverage
8+
/storybook-static
89

910
# production
1011
/build

.travis.yml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,8 @@ language: node_js
22
node_js:
33
- "node"
44
- "lts/*"
5+
- "9"
6+
- "8"
57
script:
68
- npm run build
79
- npm test -- --coverage
8-
branches:
9-
only:
10-
- master

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,22 @@ codeprinter's goal is pretty self-explanatory: to make it easier to print out co
55

66
codeprinter makes it easy. Simply copy your code into the text box, select your desired font, font size, syntax highlighting theme, and whether or not you would like line numbers and then hit print.
77

8+
## Usage
9+
codeprinter is currently hosted by GitHub Pages at http://jaredpetersen.github.io/codeprinter/.
10+
11+
If you're concerned about pasting code into some website, you can use it locally as well. codeprinter is a React project that uses NPM and Node.js, so [you'll need both installed](https://nodejs.org/en/download/) in order to do so. Right now, codeprinter supports Node 8.x or higher, but the latest LTS version is always recommended.
12+
13+
Once that's out of the way, run the following commands to install the dependencies, build the application, and run it:
14+
```
15+
npm install
16+
npm run build
17+
npm start
18+
```
19+
820
## Screenshots
921
![Paste your code](https://i.imgur.com/adhS1Cz.png)
1022
![Change your font size](https://i.imgur.com/TlgIxpi.png)
1123
![Print your code](https://i.imgur.com/IYHqP0z.png)
1224

1325
## How to Contribute
14-
Find a bug? Want to request a new feature? Awesome! Create an [issue](https://github.com/jaredpetersen/codeprinter/issues) and/or submit a [pull request](https://github.com/jaredpetersen/codeprinter/pulls). Just want to show your support for the project? [Buy me a coffee](https://paypal.me/jaredtpetersen).
26+
Find a bug? Want to request a new feature? Awesome! Create an [issue](https://github.com/jaredpetersen/codeprinter/issues) and/or submit a [pull request](https://github.com/jaredpetersen/codeprinter/pulls). Just want to show your support for the project? [Buy me a cup of coffee](https://paypal.me/jaredtpetersen).

0 commit comments

Comments
 (0)