Skip to content

Commit 863cfed

Browse files
committed
Core: fix relative paths in README.md
1 parent 268800a commit 863cfed

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/core/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@
33
[![NPM](https://img.shields.io/npm/v/uuc-core.svg)](https://www.npmjs.org/package/uuc-core)
44

55
The core library contains the logic for parsing, converting and unit definitions.
6-
It was created mainly for the [UUC Frontend app](../frontend/README.md), but is also available as a standalone library at npm.
6+
It was created mainly for the [UUC Frontend app](https://github.com/Lemonexe/UUC/blob/master/packages/frontend/README.md), but is also available as a standalone library at npm.
77
It is written in TypeScript, and is only distributed as ESM.
88

99
This page documents the _usage_ of the library for end users, as distributed via npm.
10-
If you wish to take part of the library development _(or fork it)_, please see [local dev setup instructions](./CONTRIBUTING.md).
10+
If you wish to take part of the library development _(or fork it)_, please see [local dev setup instructions](https://github.com/Lemonexe/UUC/blob/master/packages/core/CONTRIBUTING.md).
1111

1212
## Documentation basics
1313

1414
This guide assumes that you are a user of the UUC App ([live here](https://jira.zby.cz/content/UUC/)), and are familiar with its features.
1515
If not, please go through the Tutorial there, which will demonstrate typical use cases, i.e. what a typical conversion job looks like.
16-
For implementation details, refer to [the source code](./src), particularly the TypeScript declarations and unit tests.
16+
For implementation details, refer to [the source code](https://github.com/Lemonexe/UUC/blob/master/packages/core/src), particularly the TypeScript declarations and unit tests.
1717

1818
### Installation
1919

@@ -25,7 +25,7 @@ npm install uuc-core
2525
### Initialization
2626

2727
All functions are pure and stateless, so you may import and use them right away.
28-
Though if you wish to use currency units, initialize them first with an object of exchange rates to any base currency (see [API used by Frontend](../frontend/src/io/currencies.ts)):
28+
Though if you wish to use currency units, initialize them first with an object of exchange rates to any base currency (see [API used by Frontend](https://github.com/Lemonexe/UUC/blob/master/packages/frontend/src/io/currencies.ts)):
2929
```javascript
3030
import { populateCurrencies } from 'uuc-core'
3131
populateCurrencies({ USD: 1.5, EUR: 1, CZK: 26, BTC: 21e-6 }) // any subset of available currencies may be populated, others will stay undefined
@@ -97,6 +97,6 @@ and others...
9797

9898
### Errors
9999

100-
Exceptions as well as warnings are represented by the [UUCError](./src/errors.ts).
100+
Exceptions as well as warnings are represented by the [UUCError](https://github.com/Lemonexe/UUC/blob/master/packages/core/src/errors.ts).
101101
Refer to its source code for all possible error/warning codes.
102102
The main `convert` function catches errors and includes them in status and messages, but lower-level function will throw them.

packages/core/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "uuc-core",
3-
"version": "1.0.2",
3+
"version": "1.0.3",
44
"description": "Ultimate Unit Converter Core Library",
55
"homepage": "https://github.com/Lemonexe/UUC#readme",
66
"author": "Jiri Zbytovsky",

0 commit comments

Comments
 (0)