diff --git a/README.md b/README.md index 7ffcafd..394592c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,14 @@ -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). +# React WoW Classic Talent Calculator +- [React.js](https://reactjs.org/) +- [TypeScript](https://www.typescriptlang.org/) +- [Immutable.js](https://immutable-js.github.io/immutable-js/docs) +- Using functional components with [Hooks](https://reactjs.org/docs/hooks-intro.html) whenever possible ## Available Scripts In the project directory, you can run: -### `npm start` +### `yarn start` Runs the app in the development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in the browser. @@ -12,12 +16,12 @@ Open [http://localhost:3000](http://localhost:3000) to view it in the browser. The page will reload if you make edits.
You will also see any lint errors in the console. -### `npm test` +### `yarn test` Launches the test runner in the interactive watch mode.
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. -### `npm run build` +### `yarn run build` Builds the app for production to the `build` folder.
It correctly bundles React in production mode and optimizes the build for the best performance. @@ -27,7 +31,7 @@ Your app is ready to be deployed! See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. -### `npm run eject` +### `yarn run eject` **Note: this is a one-way operation. Once you `eject`, you can’t go back!** @@ -43,6 +47,9 @@ You can learn more in the [Create React App documentation](https://facebook.gith To learn React, check out the [React documentation](https://reactjs.org/). +## Credits +Original icon/background artworks by Blizzard Entertainment. Talent Data structure based on lovely folks over at Wowhead, as well as icon frames and tooltip background. + ## Startup warning ``` Starting the development server... diff --git a/TODO.md b/TODO.md index e09cfe0..eaa4da8 100644 --- a/TODO.md +++ b/TODO.md @@ -5,6 +5,7 @@ - [ ] General: Responsive on mobile - [ ] Talent tree: Arrows for dependencies (all done except for right-down arrow) - [ ] Talent tree: Reset button per tree (?) +- [ ] Fix: Initial load `pointString` validation (make sure all talents are valid and their deps are met) - [x] System: Generate URL for chosen talents - [x] Talent tree: Prettier talent frames - [x] Talent tree: Colour markings on icons