Skip to content

Commit 09c622d

Browse files
committed
Create Readme with example usage
1 parent 553df0a commit 09c622d

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,20 @@ A little Vue.js component library to display the UK EPC Ratings.
88

99
```vue
1010
<script setup lang="ts">
11-
import EPCRating from './components/EPCRating.vue';
11+
import EPCRating from 'epc-rating';
1212
</script>
1313
1414
<template>
15-
<EPCRating :current-score="72" :potential-score="85" />
15+
<EPCRating
16+
:current-score="72"
17+
:potential-score="85"
18+
/>
1619
</template>
1720
```
1821

1922
## EPC Ratings
2023

21-
An Energy Performance Certificate (EPC) tells you how energy efficient a property is. Ratings are grated from A-G. The UK Gov website not only states the current energy rating, but the potential rating given recommendations are implemented.
24+
An Energy Performance Certificate (EPC) shows how energy efficient a property is, with ratings from A to G. The UK Government website provides both the current and potential ratings for a property.
2225

2326
You can find the energy rating for a property here: https://www.gov.uk/find-energy-certificate.
2427

@@ -44,6 +47,8 @@ npm test
4447

4548
- Learn more about the recommended Project Setup and IDE Support in the [Vue Docs TypeScript Guide](https://vuejs.org/guide/typescript/overview.html#project-setup).
4649

47-
## Attributions
50+
## Attributions & Thanks
4851

49-
- This component [contains public sector information licensed under the Open Government Licence v3.0](https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/). The SVG provided is from the UK Gov website within minor alterations to work with Vue.js. Assets for all EPC related media can be found here: https://assets.publishing.service.gov.uk/media/5a748d20ed915d0e8bf19346/1790388.pdf. EPC ratings diagrams can be generated here: https://find-energy-certificate.service.gov.uk.
52+
- This component uses public sector information licensed under the [Open Government Licence v3.0](https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/). The SVG is sourced from the UK Government website, with minor adjustments for Vue.js. All EPC-related media assets can be found [here](https://assets.publishing.service.gov.uk/media/5a748d20ed915d0e8bf19346/1790388.pdf). EPC rating diagrams can be generated [here](https://find-energy-certificate.service.gov.uk).
53+
- Thanks to [Brian Barrow](https://x.com/the_brianb) for his [guide](https://www.freecodecamp.org/news/how-to-create-and-publish-a-vue-component-library-update/) on creating a Vue 3 component package.
54+
- Additional thanks to [Matija Novosel](https://www.linkedin.com/in/matijanovosel/) for his [guide](https://www.matijanovosel.com/blog/making-and-publishing-components-with-vue-3-and-vite) on preparing the npm package.

0 commit comments

Comments
 (0)