Skip to content

Commit 0e82164

Browse files
committed
Update README.md
1 parent b2edd28 commit 0e82164

File tree

4 files changed

+11
-10
lines changed

4 files changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ Assemble screenshots of web projects for your portfolio
66

77
Once a web project is done, it's time to document your hard work and show it off. _Portfoliofy_ makes that process easier by doing all the screenshots for you and assembling them together into portfolio-ready files.
88

9-
As of v2.0.0, the following files can be generated:
9+
As of v2.1.0, the following `OUTPUT_` types can be generated:
1010

11-
* `SCREENSHOTS`
12-
* Four image files of screenshots taken in different viewports (desktop - 2160x1360, laptop - 1440x900, tablet - 768x1024, smartphone - 230x490).
13-
* `MAIN`
11+
* `OUTPUT_SCREENSHOTS`
12+
* Four image files of screenshots taken in different window sizes mimicking the viewport of a desktop (2160x1360), a laptop (1440x900), a tablet (768x1024) and a smartphone (230x490).
13+
* `OUTPUT_MAIN`
1414
* An image file of those screenshots overlaid on top schematic diagrams and then collaged together. (See below for an example ouput.)
15-
* `BROWSER`
16-
* A image file of the desktop screenshot overlaid on top of a schematic diagram. (Scroll to the bottom for an example ouput.)
15+
* `OUTPUT_BROWSER`
16+
* An image file of the desktop screenshot overlaid on top of a schematic diagram. (Scroll to the bottom for an example ouput.)
1717

1818
More coming soon!
1919

@@ -42,7 +42,7 @@ Clone it!
4242
git clone https://github.com/ggeerraarrdd/portfoliofy.git
4343
```
4444

45-
Open `local_settings.py` and change the value of `url` to the one you want to portfoliofy.
45+
At minimum change the `url` [parameter](https://github.com/ggeerraarrdd/portfoliofy#parameters) in `local_settings.py` to the webpage you want to portfoliofy.
4646

4747
Then run the following command:
4848

@@ -62,7 +62,7 @@ This is a list of parameters you can change in `local_settings.py`.
6262
| wait | int | 2 | 0-60 | Time in seconds to allow URL to load before taking screenshot. |
6363
| screenshots | bool | True | True, False | If TRUE, all screenshots are saved. |
6464

65-
The `MAIN` and `BROWSER` output files are generated by default but you can change this default behavior by editing the value of `request`. You can also customize the output files.
65+
`OUTPUT_MAIN` and `OUTPUT_BROWSER` are generated by default but you can change this default behavior by editing the value of `request` in their respective dict in `user_input`. Other customizations can be set.
6666

6767
| Parameter | Type | Default value | Value range | Description |
6868
| ----------------- | ------ | ------------- | ------------ | ----------- |
@@ -76,7 +76,7 @@ The `MAIN` and `BROWSER` output files are generated by default but you can chang
7676

7777
### Example
7878

79-
This code will portfoliofy a web page served on a web server running on a local machine. It only requests the `BROWSER` output file in the default PNG format. The `MAIN` output file will not be processed. But all screenshots will be saved. All other parameters are also set to their default values.
79+
This code will portfoliofy a webpage served on a web server running on a local computer. It only requests `OUTPUT_BROWSER` in the default PNG format. `OUTPUT_MAIN` will not be processed. But all `OUTPUT_SCREENSHOTS` will be saved. All other parameters remain set to their default values.
8080

8181
```python
8282
user_input = {
@@ -123,7 +123,8 @@ The [initial realease](https://github.com/ggeerraarrdd/portfoliofy/releases/tag/
123123
New features development is ongoing.
124124

125125
* Develop a user-friendly web interface
126-
* More options
126+
* More `OUTPUT_` types
127+
* More customizations
127128

128129
## License
129130

images/portfoliofy.png

-2.23 MB
Binary file not shown.

images/portfoliofy1.png

-816 KB
Loading

images/portfoliofy2.png

-354 KB
Loading

0 commit comments

Comments
 (0)