Skip to content

Commit

Permalink
update package name
Browse files Browse the repository at this point in the history
- numbers-to-words was already taken
  • Loading branch information
jlozovei committed Apr 30, 2020
1 parent e26efb4 commit b8666c6
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 16 deletions.
26 changes: 26 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Contribution Guidelines
Well, thanks for taking a time to contribute! This is really awesome! :tada:


## How to Contribute?
There are many ways to contribute with this project: from bug reporting to performance/code enhancements, asking for new features, improving documentation...

To do so, first take a look on the [opened issues](https://github.com/jlozovei/full-numbers/issues). If you don't find any that fits your request/problem you can [open a new issue](https://github.com/jlozovei/full-numbers/issues/new) and provide a nice description of what you are asking; technical references (links, reports...) and code samples are always welcome, and they help us to find the better solution for the problems.


## Coding Conventions
Personally I'm not stricted to any `JavaScript Guideline`, but I like to keep nice patterns and use community approved conventions.

So, if you use the project's linting rules and conventions your request will be halfway approved!

Also, if possible, create test cases for your modifications - it's very important to keep the project's quality and assurance of good code!


## Pull Requests
To create a nice PR, follow the [template](https://github.com/jlozovei/full-numbers/blob/master/.github/PULL_REQUEST_TEMPLATE.md). The goal will always be to maintain/improve the project's quality and fix the existing problems; and to do so, we must keep a pattern.


## Is it your first contribution?
Take a look at the [beginner issues](https://github.com/jlozovei/full-numbers/labels/beginner) and [help wanted issues](https://github.com/jlozovei/full-numbers/labels/help%20wanted), they are a nice way to start.

Either in the project or in the open source community, your contribution will always be welcome. We (the community) will help you to create a nice and worthy contribution!
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# numbers-to-words
# full-numbers
A nice JS package to convert numbers to words. :zero: :arrow_right: :abc:
Multilanguage support! :tada:

Expand All @@ -8,20 +8,20 @@ First things first - install the package using `npm` or `yarn`:

```bash
# using npm
npm i numbers-to-words
npm i full-numbers

# using yarn
yarn add numbers-to-words
yarn add full-numbers
```

After that, import the helper wherever you want to use it:

```js
// es-modules
import numbersToWords from 'numbers-to-words';
import numbersToWords from 'full-numbers';

// commonjs
const numbersToWords = require('numbers-to-words');
const numbersToWords = require('full-numbers');
```

Then, you'll be able to use it:
Expand All @@ -47,8 +47,8 @@ const words = numbersToWords({
## :computer: Developing
First, fork the project. After it, install the dependencies (preferably using [npm](https://npmjs.com/) - since the project is using it) and do the work.

Also, take a look at the [contributing guide](https://github.com/jlozovei/numbers-to-words/blob/master/.github/CONTRIBUTING.md)!
Also, take a look at the [contributing guide](https://github.com/jlozovei/full-numbers/blob/master/.github/CONTRIBUTING.md)!


## :closed_lock_with_key: License
Licensed under the [MIT](https://github.com/jlozovei/numbers-to-words/blob/master/LICENSE).
Licensed under the [MIT](https://github.com/jlozovei/full-numbers/blob/master/LICENSE).
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 6 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "numbers-to-words",
"name": "full-numbers",
"version": "0.0.0",
"description": "A nice JS package to convert numbers to words.",
"main": "index.js",
Expand All @@ -13,25 +13,24 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/jlozovei/numbers-to-words.git"
"url": "git+https://github.com/jlozovei/full-numbers.git"
},
"author": "Julio Lozovei <[email protected]> (https://jlozovei.dev)",
"license": "MIT",
"bugs": {
"url": "https://github.com/jlozovei/numbers-to-words/issues"
"url": "https://github.com/jlozovei/full-numbers/issues"
},
"homepage": "https://github.com/jlozovei/numbers-to-words#readme",
"homepage": "https://github.com/jlozovei/full-numbers#readme",
"files": [
"dist"
],
"keywords": [
"converter",
"currency",
"number",
"string",
"full numbers",
"numbers to words",
"currency to words"
"numbers in full",
"numbers to words"
],
"devDependencies": {
"eslint": "^6.8.0",
Expand Down
2 changes: 1 addition & 1 deletion rollup.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ export default {
output: {
file: 'dist/index.js',
format: 'umd',
name: 'numbersToWords'
name: 'fullNumbers'
}
};

0 comments on commit b8666c6

Please sign in to comment.