@rcsb/rcsb-documentation 0.0.1 → 0.0.3

package/README.md

@@ -1,70 +1,38 @@
-# Getting Started with Create React App
+# RCSB Documentation Module (`@rcsb/rcsb-documentation`)
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+This project is a React application that has been configured with Webpack for building and development.
 
-## Available Scripts
-
-In the project directory, you can run:
-
-### `npm start`
-
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
-
-The page will reload when you make changes.\
-You may also see any lint errors in the console.
-
-### `npm 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`
-
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
-
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
+The **RCSB Documentation Module** is a React-based project designed to serve as a dynamic and user-friendly landing page for hosting documentation related to [RCSB.org](https://www.rcsb.org/). This module is intended to be integrated within the **RCSB Sierra** web application, providing an enhanced user experience and streamlining access to information pertinent to the features and data available on RCSB.org.
 
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+## Installation
 
-### `npm run eject`
+You can install the RCSB Documentation Module via npm:
 
-**Note: this is a one-way operation. Once you `eject`, you can't go back!**
+npm install @rcsb/rcsb-documentation
 
-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.
-
-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
+## Available Scripts
 
-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)
+Inside the project directory, you can run the following commands:
 
-### Making a Progressive Web App
+### `npm start`
 
-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)
+- Launches the development server with Webpack.
+- Open [http://localhost:3000](http://localhost:3000) to view the app in your browser.
+- The app supports hot reloading, so any changes to the source files will automatically reflect in the browser.
 
-### Advanced Configuration
+### `npm run build`
 
-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)
+- Builds the project for production.
+- Creates an optimized build in the `build` folder.
+- The output is minified, and the filenames include content hashes for cache busting.
 
-### Deployment
+## Project Structure
 
-This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
+- **`src/`**: Contains the source code of the application, including components, styles, and assets.
+- **`build/`**: The production-ready output generated by Webpack after running `npm run build`.
+- **`webpack.config.js`**: The Webpack configuration file that manages the build and bundling process.
+- **`.babelrc`**: Babel configuration file for JavaScript transpilation.
 
-### `npm run build` fails to minify
+## License
 
-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)
+This project is licensed under the [MIT License](LICENSE).