Skip to content
This repository was archived by the owner on Oct 14, 2024. It is now read-only.

Commit 6621be6

Browse files
committed
Separate changelog into its own file
1 parent adeb584 commit 6621be6

File tree

2 files changed

+150
-132
lines changed

2 files changed

+150
-132
lines changed

changelog.md

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
# Changelog
2+
3+
## v1.0.6
4+
- Bug fixes
5+
- More reliable staff notification emails
6+
- More reliable download links
7+
- More reliable discount calculations
8+
- Better calculation for `updateStock()` function
9+
- Remove reliance on `mime_content_type()` for gateway logos
10+
- Include shipping in Stripe gateway calculations
11+
- Fix typo in German language file
12+
- Add page text to `cart.php` template
13+
- Fix broken variables on `process.php` for PayPal gateway
14+
- Only show "From" in price button if there is more than one variant
15+
- Design and UI
16+
- Improved admin layout for discount codes & gift certificates
17+
- Enable panel installation from browser
18+
- Use default language instead of hardcoded `en` for updating order files on confirmation
19+
- Add Spanish language option
20+
- Full seller and buyer address info on PDF invoices
21+
22+
23+
## v1.0.5
24+
25+
- Bug fixes
26+
- Even more reliable calculation of shipping rates, subtotals, and applicable tax
27+
- New order notifications now work with PayPal and are multilingual
28+
- Fix the missing PayPal redirection message
29+
- Design and UI
30+
- Minor tweaks to "Free Shipping" and "No Tax" badge placement in the `Cart` page
31+
- Replace several nested git repos with regular files for the DomPDF plugin, for easier installation
32+
33+
## v1.0.4
34+
35+
- Bug fixes
36+
- More reliable calculation of shipping rates
37+
- Prevent DOM manipulation of discount and tax amounts in the cart
38+
- Prevent cart localization errors (resulting in NaN for the cart total)
39+
- Add multi-language support to some hard-coded strings (thanks to [concertimpromptu](https://github.com/concertimpromptu))
40+
- Remember the selected country when a user navigates away from the `Cart` page (thanks to [concertimpromptu](https://github.com/concertimpromptu))
41+
- Fix errors with subdirectory installs
42+
- Prevent prices from carrying over to the next product where prices haven't yet been set
43+
- New features
44+
- 💸 Discount codes (site-wide and per-product)
45+
- 🔑 Password reset
46+
- 👮 Opt-in email verification for new accounts
47+
- 📦 Order notification emails
48+
- 🤑 More robust "pay later" options
49+
- Design and UI
50+
- Moved login form lower in the sidebar
51+
- Better indication of failed login
52+
- Make it harder to accidentally delete your account
53+
- Better handling of thumbnails with different aspect ratios (burry background fills up the dead space, like instagram)
54+
- Minimum 150px width for listing items
55+
- Removed title for the search bar
56+
- Better icons for `Category` and `Product` pages in the panel
57+
- Better UI for drag-and-drop file uploads in the panel
58+
- Smarter top menu layout (adapts to the number of menu items)
59+
- German language option (thanks to [medienbaecker](https://github.com/medienbaecker))
60+
- Also apologies to [medienbaecker](https://github.com/medienbaecker) for my terrible google translate on the remainder of the German strings
61+
- Switched to [dompdf](https://dompdf.github.com/) for generating PDF Invoices (allows for easier HTML layout)
62+
- Moved page logic into controllers
63+
- RTL text support in templates
64+
- Explicit timezone definition in `config.php`
65+
- Smarter onboarding notifications
66+
- Hidden honeypot form fields for spam protection
67+
- Removed `wholesaler` user role (preferential pricing now handled with discount codes instead of roles)
68+
- Auto-shrink large image uploads
69+
70+
## v1.0.3
71+
72+
- Bug fixes
73+
- Fixed login redirect on subfolder installs
74+
- Removed incorrect help text from `Register` page
75+
- Theme options
76+
- Choose custom colours (Shopkit adjusts brightness to ensure readability)
77+
- Background colour & image options, including blurred background
78+
- Panel improvements
79+
- Improved UI for selecting images
80+
- Numeric field validation within structure fields
81+
- Tabbed layout to organize site options and shop settings
82+
- Added `Brand` as a default product field (helps with Google rich data snippets)
83+
- Added hours of operation to the `Contact` page as a separate field
84+
- Added `Related products` to the `Default` template
85+
- Stylish photo slider for most templates
86+
- Updated admin navbar with new icons and `Design` button for theme options
87+
- Added currency code (e.g. USD) to `Cart` page for clarity
88+
- Set currency to $USD by default
89+
- Friendlier error page text
90+
- Sidebar sections are hidden if content is not populated (i.e. categories, contact info)
91+
92+
## v1.0.2
93+
94+
- Improved reliability for PayPal transaction confirmation
95+
- User registration has one name field instead of separate first/last name fields
96+
- Fixed shipping bug related to updated multiselect syntax
97+
- Clearer instructions when logging in from /panel
98+
- Add some padding to the bottom of <main>
99+
100+
## v1.0.1
101+
102+
- Upgrade Kirby core & panel to 2.2.3
103+
- Panel improvements
104+
- Template-specific icons in the sidebar
105+
- Protect core pages from deletion
106+
- Autopublish for all templates
107+
- Some structure fields display in table format
108+
- Add Schema.org RDFa data to product templates so rich snippets show up in Google & Bing
109+
- Support for installing Shopkit in a subdirectory
110+
- Add Shop settings button in the admin bar
111+
- Bugfixes & layout tweaks
112+
113+
## v1.0
114+
115+
- Inventory control
116+
- New payment logic to support multiple gateways (PayPal only for now, but you can easily add your own)
117+
- Browse products in slideshow view
118+
- Onboarding prompts to help new users set up shop options and create their first product
119+
- Multi-language setup (English and French available right now)
120+
- New pages visible by default (thanks to the [Kirby Auto Publish](https://github.com/groenewege/kirby-auto-publish) plugin)
121+
- [Visual markdown](https://github.com/JonasDoebertin/kirby-visual-markdown) editor
122+
- Admin menu for logged-in users
123+
- New theme
124+
- Leaner, modular CSS
125+
- Minimalist design for easy customization
126+
- More flexible gallery layout (images of all aspect ratios look great)
127+
- Thumbnail previews in cart
128+
- Other changes
129+
- Use email instead of username to log in
130+
- Improved order flow (orders are logged even if user doesn't return from PayPal)
131+
- Shop is the homepage by default
132+
- Order statuses changed to "Pending", "Paid", or "Shipped"
133+
- Bugfix: Allow multiple options of a variant in the cart
134+
- Bugfix: Cart stuck in PayPal sandbox mode
135+
- Security fix: [Rewritebase vulnerability](https://forum.getkirby.com/t/security-check-your-rewritebase-settings/2142)

readme.md

Lines changed: 15 additions & 132 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Full [docs here](http://shopkit.samnabi.com/docs).
1111
### Products & shop settings
1212

1313
- Easy product <strong>variants and options</strong> <small>(e.g. sizes and colours)</small>
14-
- Easy <strong>flexible shipping rates</strong> <small>(Flat rate, per item, by weight, or by total price)</small>
14+
- <strong>Flexible shipping rates</strong> <small>(Flat rate, per item, by weight, or by total price)</small>
1515
- <strong>Related products</strong>
1616
- <strong>Inventory control</strong>
1717
- <strong>Discount codes</strong> (site-wide and product-specific)
@@ -45,7 +45,7 @@ You can try Shopkit for free on your local machine or a test server, forever. On
4545

4646
Since Shopkit runs on the Kirby CMS, you'll also have to buy a [Kirby license](http://getkirby.com/license) from Bastian.
4747

48-
## Installation
48+
## Install
4949

5050
Shopkit, just like Kirby, does not require a database, which makes it very easy to install. Just copy the files to your server and visit the URL for your website in the browser.
5151

@@ -61,7 +61,17 @@ If you are familiar with the terminal, you can clone Shopkit from GitHub.
6161

6262
git clone --recursive https://github.com/samnabi/shopkit.git
6363

64-
### Update
64+
## Configure
65+
66+
Most of Shopkit's configuration happens in the shop page, located at `/content/1-shop/shop.en.txt`. This includes defining your shipping methods, tax rates, user permissions, and payment details.
67+
68+
Your shop logo and theme options are defined in the site options, located at `/content/site.en.txt`.
69+
70+
Of course, there are helpful blueprints so you can easily manage everything from the panel.
71+
72+
Before your site goes public, you'll need to enter your license keys in the `/site/config/config.php` file.
73+
74+
## Update
6575

6676
Use these terminal commands to update Shopkit and all its dependencies to the latest commit in the `master` branch.
6777

@@ -74,18 +84,7 @@ Use these terminal commands to update Shopkit and all its dependencies to the la
7484
git checkout master
7585
git pull
7686

77-
78-
## Configuration
79-
80-
Most of Shopkit's configuration happens in the shop page, located at `/content/1-shop/shop.en.txt`. This includes defining your shipping methods, tax rates, user permissions, and payment details.
81-
82-
Your shop logo and theme options are defined in the site options, located at `/content/site.en.txt`.
83-
84-
Of course, there are helpful blueprints so you can easily manage everything from the panel.
85-
86-
Before your site goes public, you'll need to enter your license keys in the `/site/config/config.php` file.
87-
88-
## Upgrading from v1.0.3
87+
### Updating from v1.0.3
8988

9089
If you're upgrading from Shopkit 1.0.3 or earlier, note that the location of the `Register` page has changed, and a new page called `Reset` has been introduced. The new folder structure looks like this:
9190

@@ -96,7 +95,7 @@ content/
9695
reset/
9796
```
9897

99-
## Upgrading from v0.9
98+
### Updating from v0.9
10099

101100
If you're upgrading from Shopkit 0.9.2 or earlier, you'll have to change some things manually:
102101

@@ -105,122 +104,6 @@ If you're upgrading from Shopkit 0.9.2 or earlier, you'll have to change some th
105104
- In every product's text file, change `Prices:` to `Variants:`.
106105
- In every order's text file, change the order status values to reflect the new values: `pending`, `paid`, or `shipped`.
107106

108-
## Changelog
109-
110-
### v1.0.5
111-
112-
- Bug fixes
113-
- Even more reliable calculation of shipping rates, subtotals, and applicable tax
114-
- New order notifications now work with PayPal and are multilingual
115-
- Fix the missing PayPal redirection message
116-
- Design and UI
117-
- Minor tweaks to "Free Shipping" and "No Tax" badge placement in the `Cart` page
118-
- Replace several nested git repos with regular files for the DomPDF plugin, for easier installation
119-
120-
### v1.0.4
121-
122-
- Bug fixes
123-
- More reliable calculation of shipping rates
124-
- Prevent DOM manipulation of discount and tax amounts in the cart
125-
- Prevent cart localization errors (resulting in NaN for the cart total)
126-
- Add multi-language support to some hard-coded strings (thanks to [concertimpromptu](https://github.com/concertimpromptu))
127-
- Remember the selected country when a user navigates away from the `Cart` page (thanks to [concertimpromptu](https://github.com/concertimpromptu))
128-
- Fix errors with subdirectory installs
129-
- Prevent prices from carrying over to the next product where prices haven't yet been set
130-
- New features
131-
- 💸 Discount codes (site-wide and per-product)
132-
- 🔑 Password reset
133-
- 👮 Opt-in email verification for new accounts
134-
- 📦 Order notification emails
135-
- 🤑 More robust "pay later" options
136-
- Design and UI
137-
- Moved login form lower in the sidebar
138-
- Better indication of failed login
139-
- Make it harder to accidentally delete your account
140-
- Better handling of thumbnails with different aspect ratios (burry background fills up the dead space, like instagram)
141-
- Minimum 150px width for listing items
142-
- Removed title for the search bar
143-
- Better icons for `Category` and `Product` pages in the panel
144-
- Better UI for drag-and-drop file uploads in the panel
145-
- Smarter top menu layout (adapts to the number of menu items)
146-
- German language option (thanks to [medienbaecker](https://github.com/medienbaecker))
147-
- Also apologies to [medienbaecker](https://github.com/medienbaecker) for my terrible google translate on the remainder of the German strings
148-
- Switched to [dompdf](https://dompdf.github.com/) for generating PDF Invoices (allows for easier HTML layout)
149-
- Moved page logic into controllers
150-
- RTL text support in templates
151-
- Explicit timezone definition in `config.php`
152-
- Smarter onboarding notifications
153-
- Hidden honeypot form fields for spam protection
154-
- Removed `wholesaler` user role (preferential pricing now handled with discount codes instead of roles)
155-
- Auto-shrink large image uploads
156-
157-
### v1.0.3
158-
159-
- Bug fixes
160-
- Fixed login redirect on subfolder installs
161-
- Removed incorrect help text from `Register` page
162-
- Theme options
163-
- Choose custom colours (Shopkit adjusts brightness to ensure readability)
164-
- Background colour & image options, including blurred background
165-
- Panel improvements
166-
- Improved UI for selecting images
167-
- Numeric field validation within structure fields
168-
- Tabbed layout to organize site options and shop settings
169-
- Added `Brand` as a default product field (helps with Google rich data snippets)
170-
- Added hours of operation to the `Contact` page as a separate field
171-
- Added `Related products` to the `Default` template
172-
- Stylish photo slider for most templates
173-
- Updated admin navbar with new icons and `Design` button for theme options
174-
- Added currency code (e.g. USD) to `Cart` page for clarity
175-
- Set currency to $USD by default
176-
- Friendlier error page text
177-
- Sidebar sections are hidden if content is not populated (i.e. categories, contact info)
178-
179-
### v1.0.2
180-
181-
- Improved reliability for PayPal transaction confirmation
182-
- User registration has one name field instead of separate first/last name fields
183-
- Fixed shipping bug related to updated multiselect syntax
184-
- Clearer instructions when logging in from /panel
185-
- Add some padding to the bottom of <main>
186-
187-
### v1.0.1
188-
189-
- Upgrade Kirby core & panel to 2.2.3
190-
- Panel improvements
191-
- Template-specific icons in the sidebar
192-
- Protect core pages from deletion
193-
- Autopublish for all templates
194-
- Some structure fields display in table format
195-
- Add Schema.org RDFa data to product templates so rich snippets show up in Google & Bing
196-
- Support for installing Shopkit in a subdirectory
197-
- Add Shop settings button in the admin bar
198-
- Bugfixes & layout tweaks
199-
200-
### v1.0
201-
202-
- Inventory control
203-
- New payment logic to support multiple gateways (PayPal only for now, but you can easily add your own)
204-
- Browse products in slideshow view
205-
- Onboarding prompts to help new users set up shop options and create their first product
206-
- Multi-language setup (English and French available right now)
207-
- New pages visible by default (thanks to the [Kirby Auto Publish](https://github.com/groenewege/kirby-auto-publish) plugin)
208-
- [Visual markdown](https://github.com/JonasDoebertin/kirby-visual-markdown) editor
209-
- Admin menu for logged-in users
210-
- New theme
211-
- Leaner, modular CSS
212-
- Minimalist design for easy customization
213-
- More flexible gallery layout (images of all aspect ratios look great)
214-
- Thumbnail previews in cart
215-
- Other changes
216-
- Use email instead of username to log in
217-
- Improved order flow (orders are logged even if user doesn't return from PayPal)
218-
- Shop is the homepage by default
219-
- Order statuses changed to "Pending", "Paid", or "Shipped"
220-
- Bugfix: Allow multiple options of a variant in the cart
221-
- Bugfix: Cart stuck in PayPal sandbox mode
222-
- Security fix: [Rewritebase vulnerability](https://forum.getkirby.com/t/security-check-your-rewritebase-settings/2142)
223-
224107
## Issues and feedback
225108

226109
If you have a GitHub account, please report issues and post feedback on the [issues page](https://github.com/samnabi/shopkit/issues).

0 commit comments

Comments
 (0)