Skip to content

Commit 9d12aec

Browse files
committed
README.md updates, .replit updates
1 parent 847b5e7 commit 9d12aec

File tree

4 files changed

+53
-59
lines changed

4 files changed

+53
-59
lines changed

.replit

+1-10
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,6 @@
1-
entrypoint = "index.js"
21

32
hidden = [".config"]
4-
5-
[interpreter]
6-
command = [
7-
"prybar-nodejs",
8-
"-q",
9-
"--ps1",
10-
"\u0001\u001b[33m\u0002\u0001\u001b[00m\u0002 ",
11-
"-i"
12-
]
3+
run = "npm i && npm run dev"
134

145
[[hints]]
156
regex = "Error \\[ERR_REQUIRE_ESM\\]"

CONTRIBUTING.md

-34
This file was deleted.

README.md

+22
Original file line numberDiff line numberDiff line change
@@ -193,3 +193,25 @@ When using a specific camera setting in iOS, EXIF data gets stripped by default:
193193
In order for this to work, a user will need to change their iOS camera settings to "Most Compatible" as below:
194194

195195
![image](https://user-images.githubusercontent.com/6023705/87861285-d2b6a180-c912-11ea-9c44-d29c784cb783.png)
196+
197+
## Contributing
198+
199+
The fastest way to contribute back is to fork the repl.it of this repo (https://replit.com/@grales/browser-image-resizer). Please open any Issues if you have trouble spinning it up.
200+
201+
### repl.it First-time Setup
202+
203+
Upon forking of the repl.it, open a new Shell and follow these instructions:
204+
205+
1. Execute `npm link` at the top `~/browser-image-resizer` folder
206+
1. Execute `cd tests/bir-vue`
207+
2. Execute `npm i && npm link browser-image-resizer && npm run serve`
208+
3. Your repl.it should automatically boot to a webview of a Vue 3 CLI SPA
209+
- This SPA will point to your built copy of browser-image-resizer that runs automatically when the repl.it boots
210+
4. Modify any code at the top level `src/` and it will reflect on your Vue 3 CLI SPA test app
211+
212+
### repl.it Specifics
213+
214+
- The repl.it above is configured to run the `dev` script of the library, which is a webpack-dev-server that auto-generates the `dist/` library which is the entry point of this library
215+
- The subsequent commands gives you an actual web application on which to verify your changes
216+
- If you prefer, you can do this locally as well, but the repl.it ensures a faster and more consistent onboarding
217+

tests/bir-vue/package-lock.json

+30-15
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)