Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝: Add a Support paragraph to Readme #846

Merged
merged 5 commits into from
Aug 6, 2024
Merged

📝: Add a Support paragraph to Readme #846

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
edaba0a
📝: Add a `Support` paragraph to Readme
xannyxs Aug 6, 2024
e9c3072
🔥 Removed comments from the README.md
Mario-SO Aug 6, 2024
0745a66
🔥 Forgot some comments
Mario-SO Aug 6, 2024
db7400b
🔥 Removed duped statement for issue submissions
Mario-SO Aug 6, 2024
0a3b539
📝 Bug emoji hehe
Mario-SO Aug 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 6 additions & 59 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
Certainly! I'll add back the message about accepting issues. Here's the updated README.md with that information included:

# StreamETH Platform 🎥🌐

Welcome to the StreamETH platform repository! StreamETH produces world-class Virtual Events and Marketing Content. This README provides you with essential information about our platform. 🚀
Expand All @@ -22,13 +20,6 @@ For a better understanding of what StreamETH offers and how it functions, please
- **Application Site**: [streameth.org/studio](https://streameth.org/studio) - Interact with the StreamETH application. 🎬
- **Create an event with us**: [Create Event](https://xg2nwufp1ju.typeform.com/to/UHZwa5M3?typeform-source=info.streameth.org)

<!-- ## Documentation Resources 📚 -->
<!---->
<!-- You can find detailed documentation on StreamETH's features and architecture here: -->
<!---->
<!-- - **[Documentation Link](#)**: Dive deep into the technical details and operational aspects of StreamETH. 📖 -->


## Goals of StreamETH 🎯

Our mission with StreamETH is to:
Expand All @@ -38,63 +29,15 @@ Our mission with StreamETH is to:
- Foster a community-driven approach to virtual event management. 🤝
- Be the go-to event management platform for pre-production, production, and post-production 🎯

<!-- ## Setup Quickstart ⚡ -->
<!---->
<!-- While we are not currently accepting external code contributions, we provide this setup information for transparency and future reference: -->
<!---->
<!-- ### Prerequisites 📋 -->
<!---->
<!-- - Node.js (v18 or above) 🟢 -->
<!-- - Yarn 🧶 -->
<!-- - Git 🐙 -->
<!---->
<!-- ### Environment Variables 🔐 -->
<!---->
<!-- Create a `.env` file at the root of the project and include the following variables: -->
<!---->
<!-- ```bash -->
<!-- # Session secret key -->
<!-- SESSION_SECRET=Generate key: "openssl rand -base64 64" -->
<!---->
<!-- # WalletConnect Project ID -->
<!-- NEXT_PUBLIC_WALLETCONNECT_PROJECT_ID=your_walletconnect_project_id_here -->
<!---->
<!-- # Infura Project ID -->
<!-- NEXT_PUBLIC_INFURA_ID=your_infura_project_id_here -->
<!---->
<!-- # Sanity Studio API Key -->
<!-- NEXT_PUBLIC_STUDIO_API_KEY=your_Livepeer_studio_api_key_here -->
<!---->
<!-- # Service Account Private Key for server-to-server interactions -->
<!-- SERVICE_ACCOUNT_PRIVATE_KEY=your_service_account_private_key_here -->
<!---->
<!-- # Service Account Email -->
<!-- SERVICE_ACCOUNT_EMAIL=your_service_account_email_here -->
<!---->
<!-- # Google API Key for services like Google Maps, etc. -->
<!-- GOOGLE_API_KEY=your_google_api_key_here -->
<!-- ``` -->
<!---->
<!-- Make sure to replace your_..._here with your actual environment variable values. -->
<!---->
<!-- ### Running Locally 🏃‍♂️ -->
<!---->
<!-- ```bash -->
<!-- git clone [email protected]:streamethorg/streameth-platform.git -->
<!-- cd streameth-platform -->
<!-- yarn install -->
<!-- yarn dev # or yarn dev -->
<!-- ``` -->

## Submitting Issues 🐛

We welcome issue submissions! If you encounter any bugs, have feature requests, or want to suggest improvements, please open an issue on our GitHub repository by clicking [here](https://github.com/streamethorg/streameth-platform/issues). Your feedback helps us improve StreamETH for everyone. 📝
If you encounter any bugs, have feature requests, or want to suggest improvements, please open an issue on our GitHub repository by clicking [here](https://github.com/streamethorg/streameth-platform/issues). Your feedback helps us improve StreamETH for everyone. 📝

## ⚠️ Important Notice for Developers 🛠️

**Please Note**: At this time, StreamETH is not open for external code contributions. We are a small team focused on delivering a high-quality product, and we are not currently set up to manage external developer code contributions effectively. We appreciate your interest, but we kindly ask that you refrain from submitting pull requests or expecting to contribute code at this stage. 🙏

However, we do welcome and appreciate [issue submissions!](https://github.com/streamethorg/streameth-platform/issues) If you encounter bugs, have feature requests, or want to provide suggestions, please feel free to open an issue. Your feedback is valuable to us. 🐛💡
However, we do welcome and appreciate [issue submissions!](https://github.com/streamethorg/streameth-platform/issues) If you encounter bugs 🐛, have feature requests, or want to provide suggestions, please feel free to open an issue. Your feedback is valuable to us. 🐛💡

We plan to support full developer contributions in the future once we feel ready to manage them properly. We will update this README when that time comes. Thank you for your understanding. 🌟

Expand All @@ -103,3 +46,7 @@ We plan to support full developer contributions in the future once we feel ready
We value the community's interest in our project. We will update this README when we are ready to welcome full external contributions. Thank you for your patience and support as we continue to develop and improve StreamETH. 🙌

Stay tuned for exciting updates and features! 🎉

## Support

We're here to help! If you have questions about our platform, please don't hesitate to reach out to [email protected].
Loading