Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
iuridepaula authored Aug 1, 2022
1 parent 95d3f2b commit 5201303
Showing 1 changed file with 18 additions and 27 deletions.
45 changes: 18 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,24 @@
# iuri.is()

## 2022 "update"
🧚 Listen!

Thanks for your interest in my website! 🙌
Before you start, noticed that this website was built in 2018/2019 and made use of solutions available at the time that are no longer the best way of doing things today! Still, I encourage you to check this solution if you are looking for inspiration, but if you are looking for a "better" way of creating animated websites today, please check these references:

This project was created back in 2018 and has never being updated since then.

I'm now releasing an "updated" version where I only fixed the failing dependencies and missing configurations to be able to run this project again.

So now you can explore this project if you are looking for inspiration or just curious about how it works.

That said,
I do not recommend you to reuse this code directly on a project nowaways!
There are MANY better ways today to build the same kind of project.

Please check these references for more modern approcahes:

- [GSAP 3](https://greensock.com/gsap/)
- [GSAP 3](https://greensock.com/3/)
- [GSAP ScrollTrigger](https://greensock.com/scrolltrigger/)
- [Vue 3](https://vuejs.org/)

---

## New version

I'm currently working on a new portfolio to replace this old one, but since many people still visiting it today I decided to refactor it and make this code more re-usable for all of you. So please be patient!

I'll publish a new version built with React, and another one with Vue.
The main idea will be to allow you guys to re-use all animated components easily on your own projects.
- [Pixi.js](https://pixijs.com/)
- [Three.js](https://threejs.org/)
- [WebGL](https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API)

---

### Hot to run
## How to run

1. Clone this repo ([how to clone a repo](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository))
2. Install dependencies
3. Run

After cloning the repo in your machine
After cloning the repo in your machine, run:

```
npm install
Expand All @@ -47,3 +28,13 @@ npm start
```

That's it 🎉

---

### New version

I'm currently working on a new portfolio to replace this old one, but since many people's still visiting this one today, I decided to refactor it and make this code more re-usable for all of you. So please be patient!

I'll publish a new versions built with React Hooks and Vue's composition API.
The main idea will be to allow you guys to re-use/build animated components easily on your own projects, based on GSAP 3 and ScrollTrigger.

0 comments on commit 5201303

Please sign in to comment.