Skip to content

Commit

Permalink
Updating the readme and the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
metincansiper committed Jan 3, 2024
1 parent c94d4e0 commit 72e07e7
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ const BasicExample = () => {
```

## Learn More
For more detailed information on how to utilize `React Bounded Overlay Manager` to its fullest, explore the [documentation](./link/to/docs/here)
For more detailed information on how to utilize `React Bounded Overlay Manager` to its fullest, explore the [documentation](https://metincansiper.github.io/react-bounded-overlay-manager)

## For Developers
If you are interested in contributing to the project or want to build and test the library, please refer to our [Developer Guide](./readme_supplements/DEVELOPER_GUIDE.md) for detailed instructions on setup, development, testing, and deployment.
3 changes: 3 additions & 0 deletions readme_supplements/DEVELOPER_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ This guide provides essential information for developers interested in contribut
- Execute `npm run test` for unit or simpler integration tests. These tests typically focus on internal logic and functionality, not requiring a full browser environment.
- Execute `npm run test:browser` for comprehensive tests that simulate a browser environment, including headless mode. This option is suitable for in-depth UI and interaction testing with Cypress, providing a closer approximation to user experiences.

## Updating the Docs
- Execute `npm run build-and-deploy-storybook`

## Contributing
- Fork the repository and create a new branch for your feature or fix.
- Make sure to include tests for new features.
Expand Down

0 comments on commit 72e07e7

Please sign in to comment.