docs: readme

README.md

@@ -1,70 +1,39 @@
-# Getting Started with Create React App
+# BioInformatics Algorithms Implementation and visualizatoin
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+deployed live [here](https://bit.ly/3fklUMv) it takes a while to initally load due to the heroku free account limitations
 
-## Available Scripts
+## Built with
 
-In the project directory, you can run:
+-   React
+-   Heroku
 
-### `npm start`
+## Implemented Algorithms
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+-   Needleman Wunsch
+-   Smith & Waterman
+-   Dot plot Matrix
+-   Dot plot Matrix with window
+-   Maximum Score Matrix
 
-The page will reload if you make edits.\
-You will also see any lint errors in the console.
+The alignment and alignment score are displayed for the following algorithms
 
-### `npm test`
+-   Needleman Wunsch
+-   Smith & Waterman
 
-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.
+# screenshots
 
-### `npm run build`
+## Inputs
 
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
+![Inputs](documentation/inputs.jpg)
 
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
+## Needleman Wunsch, steps navigation
 
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+![Needleman and Wunsch algorithm](documentation/needleman.jpg)
 
-### `npm run eject`
+## Dot Plot Matrix
 
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+![Dot Plot matrix](documentation/dotplot.jpg)
 
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+## Alignments found
 
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
-
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
-
-### Code Splitting
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
-
-### Analyzing the Bundle Size
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
-
-### Making a Progressive Web App
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
-
-### Advanced Configuration
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
-
-### Deployment
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
-
-### `npm run build` fails to minify
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
+![Alignments](documentation/alignments.jpg)