Animal 2.0.0

Author: Awilum

CHANGELOG.md

@@ -1,3 +1,10 @@
+<a name="2.0.0"></a>
+# [2.0.0](https://github.com/faker-javascript/animal) (2022-01-09)
+
+### BREAKING CHANGES
+
+* New function `animal` istead of `fakeAnimal`
+
 <a name="1.0.0"></a>
 # [1.0.0](https://github.com/faker-javascript/animal) (2022-01-09)
 * Initial release

README.md

@@ -15,15 +15,15 @@ $ npm install --save @fakerjs/animal
 ## Usage
 
 ```js
-import fakeAnimal from '@fakerjs/animal';
+import animal from '@fakerjs/animal';
 
-fakeAnimal();
+animal();
 //=> Snow Leopard
 
-fakeAnimal({type: 'zoo'});
+animal({type: 'zoo'});
 //=> Snow Leopard
 
-fakeAnimal({type: 'zoo', locale: 'en_US'});
+animal({type: 'zoo', locale: 'en_US'});
 //=> Snow Leopard
 
 // Allowed type: ocean, desert, grassland, forest, farm, pet, zoo

index.js

@@ -1,6 +1,6 @@
 {
   "name": "@fakerjs/animal",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Animal package provides functionality to generate a fake animal value.",
   "license": "MIT",
   "repository": "faker-javascript/animal",
@@ -25,6 +25,7 @@
   ],
   "keywords": [
     "fakerjs",
+    "faker",
     "fake",
     "random",
     "animal"

package.json

@@ -1,10 +1,10 @@
-import fakeProfession from './index.js';
+import animal from './index.js';
 import test from 'ava';
 
-test('fakeAnimal return type to be string', t => {
-	t.is(typeof fakeProfession(), 'string');
+test('animal return type to be string', t => {
+	t.is(typeof animal(), 'string');
 });
 
-test('fakeAnimal with type and locale return type to be string', t => {
-	t.is(typeof fakeProfession({type: 'zoo', locale: 'en_US'}), 'string');
+test('animal with type and locale return type to be string', t => {
+	t.is(typeof animal({type: 'zoo', locale: 'en_US'}), 'string');
 });