Skip to content

Commit

Permalink
Add LICENSE, proper README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
handsomelatino committed May 23, 2022
1 parent 6c81fbb commit 7a697dc
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 57 deletions.
21 changes: 21 additions & 0 deletions LICENSE
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 Handsome Latino

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.
80 changes: 28 additions & 52 deletions README.md
@@ -1,70 +1,46 @@
# Getting Started with Create React App
# Bitcoin Crossword

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
![Did you check the favicon?](https://bitcoin-crossword.com/crossword.png)

## Available Scripts
A bounty remains hidden behind this 5-word crossword, available at **[bitcoin-crossword.com](https://bitcoin-crossword.com)**.

In the project directory, you can run:
Created by [Handsome Latino](https://handsomelatino.com) using [React](https://github.com/facebook/create-react-app).

### `yarn start`
## The total bounty is:

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
- ~0.01 BTC (one million sat)~
- 0.01006614 BTC (1,006,614 sats)

The page will reload when you make changes.\
You may also see any lint errors in the console.
Donations to the bounty address are welcome while the puzzle remains unsolved.

### `yarn test`
[`bc1qe926cfhzyh438fyvn9snyrcrsfujp6ur3zcrrn`](https://mempool.space/address/bc1qe926cfhzyh438fyvn9snyrcrsfujp6ur3zcrrn)

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.
## Running the project

### `yarn build`
To run the project locally, clone the repository and run

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
```
yarn start
```

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
To generate your own custom message and key, you must create to files on the root of the project:

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
```
_message.md <- markdown-flavored message to encrypt
_message_key.txt <- cleartext key in a single line
### `yarn eject`
yarn encrypt-message
```

**Note: this is a one-way operation. Once you `eject`, you can't go back!**
A `public/cypher.txt` will be created. Note that the key must be a permutation of words that solves the puzzle.

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.
## Production Build

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.
The following command will create a `build` production directory:
```
yarn build
```

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.
## License

## 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)

### `yarn 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)
[MIT License](/LICENSE)
10 changes: 5 additions & 5 deletions public/favicon.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7a697dc

Please sign in to comment.