Merge pull request #42 from oss-slu/License

Added MIT License and updated README

CONTRIBUTING.md

@@ -21,14 +21,14 @@ Thank you for considering contributing to **Rerum Playground**! We appreciate yo
   ```
 
 ### 4. Set Up Your Environment
-- The code base is in HTML, CSS, JS so there are no extentions or seperate software installation is requred. Just run the code it will open and renders in your default browser.
+- The code base is in HTML, CSS, JS so there is no seperate software installation is requred. Just run the code it will open and renders in your default browser. Use the live server extention if needed.
 
 ---
 
 ## Contribution Workflow
 
-### 1.Choose an Issue associated with the label **hacktoberfest**
-- Choose the Issue associated with the label hacktoberfest and clearly read all the details and acceptance criteria for the issue before starting to work on the issue.
+### 1.Choose an Issue from issue board
+- Choose the Issue and clearly read all the details and acceptance criteria for the issue before starting to work on the issue.
 
 ### 2. Make Your Changes
 - Work on your branch locally. Implement your changes and test them thoroughly to ensure they work correctly.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Open Source with SLU
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,4 +1,45 @@
 # Rerum Playground
 This is a web space that uses the RERUM installation at the Walter J. Ong,<sub><sup> S.J.</sup></sub> Center for Digital Humanities to explore the possibilities of interoperable tools and standards. By using the Tiny Things sandbox, users can immediately create reusable JSON-LD objects that conform to IIIF and Web Annotation standards and find new ways to interact with them.
 
+**RERUM Playground** is a web-based toolset enabling users to work with IIIF manifests and JSON-LD objects. Users can bring their own manifest or create one within the playground, then use the listed tools to visualize, edit, and redirect the manifest to other compatible applications.
+
+## Overview
+
+This project allows users to create, interact with, and manage IIIF-compliant JSON-LD objects, with an intuitive interface.
+
+### Key Features
+- **Manifest Handling**: Import or create IIIF manifests.
+- **Tool Integration**: Choose tools to interact with manifests, redirecting to compatible applications.
+- **Local Storage**: Manifests persist locally for easy access across sessions.
+
+## Setup
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/oss-slu/rerum-playground.git
+   ```
+2. Open the project in your preferred code editor.
+3. Use the Live Server extension to launch the app:
+   - Right-click on `index.html` and select "Open with Live Server."
+
+## Usage
+
+- **Create or Import a Manifest**: Start with your own manifest or use the creation tool.
+- **Explore Tools**: Select from available tools to visualize or enhance your manifest, with redirection support.
+
+## Project Structure
+
+- **`web/`**: Contains frontend files, including HTML, CSS, and JavaScript.
+- **`.github/`**: GitHub-specific configuration files for CI workflows.
+- **`README.md`**: Setup and project overview.
+
+## Contributing
+
+Contributions are welcome! Check out the `CONTRIBUTING.md` for guidelines.
+
+## License
+
+Licensed under the MIT License. See `LICENSE` for more details.
+
+---